Resource object representing subscription
" }, "advance_invoice_schedules" : { "type" : "array", "description" : "Resource object representing advance_invoice_schedule
", "items" : { "$ref" : "#/components/schemas/AdvanceInvoiceSchedule", "description" : "Resource object representing advance_invoice_schedule" }, "example" : null } }, "required" : [ "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/update_for_items" : { "post" : { "summary" : "Update subscription for items", "description" : "Updates a subscription by modifying its item prices, coupons, billing configuration, payment method, and other attributes. Any parameters not provided remain unchanged. The changes can be applied immediately, scheduled for a future date, or even backdated to a past date.
draft status if the auto-draft conditions are met.draft status if the auto-draft conditions are met.subscription.billing_override.prorate is true, prorated credits may be created for the unused service periods of the subscription items.payment_intent, payment_method, or card parameters are provided, a new payment source is created for the customer and associated with the subscription as the payment_source_id.To add new item prices to the subscription, pass them in the subscription_items parameter.
Consider a subscription with the following item prices:
plan-a-monthly-usdaddon-b-monthly-usdIf you call this API with the following item price:
addon-c-monthly-usdThe subscription will be updated to include the following item prices:
plan-a-monthly-usdaddon-b-monthly-usdaddon-c-monthly-usdTo replace all existing item prices in the subscription with a new set of item prices, include the replace_items_list parameter and set it to true.
Consider a subscription with the following item prices:
plan-a-monthly-usdaddon-b-monthly-usdIf you call this API with the following item prices and set replace_items_list to true:
plan-c-monthly-usdaddon-d-monthly-usdThe subscription will be updated to include only the new item prices:
plan-c-monthly-usdaddon-d-monthly-usdpayment_intentUse the payment_intent parameter to create a payment source for the customer. Using payment intents is the recommended way to create a payment source in Chargebee for both Strong Customer Authentication (SCA) (i.e. 3D-Secure) and non-SCA flows.
payment_intent resource by calling the Create a payment intent API.payment_intent object to your frontend and use Chargebee.js to capture the payment source details from the customer. Use Payment Method Helpers to show payment method UIs and collect payment method details from the customer.payment_intent_updated event. Once the payment_intent.status is authorized, pass the payment_intent.id using the payment_intent[id] parameter in this API call.payment_methodIf you prefer to use the payment gateway's SDKs to capture the payment method details, you can then use the payment_method parameter in this API to pass the payment method token and other details.
payment_method[reference_id] or payment_method[tmp_token] parameter along with any additional parameters required by the payment gateway to create the payment source.cardIf you are PCI compliant, you can pass raw card details via this API. Use the card parameter to pass the card details.
Determines whether the provided subscription_items replace existing subscription items or are added to the existing list.
When subscription_items includes a plan
true: The entire subscription item list (plan and addons) is replaced by the provided list.false: The provided items are added to the existing list. If multi-plan subscriptions is disabled, the existing plan item price is replaced. If multi-plan subscriptions is enabled, the existing plan item price is retained.When subscription_items contains only addons
true: Existing addons are replaced by the provided addons, except mandatory addons (auto-attached to the plan). Mandatory addons are kept unless you list them in mandatory_items_to_remove. The subscription will have the current plan, the addons you passed, plus any existing mandatory addons not in mandatory_items_to_remove.false: The provided addons are added to the existing addons.Updates Net D for the subscription. Net D is the number of days from invoice.date until payment for the invoice is due.
Constraints
-1. When reset, it is not returned by the API, and the net_term_days value set at the customer level is used instead.The document date displayed on the invoice PDF. Use this parameter to backdate the invoice for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date.
\nPrerequisites
invoice_immediately must be true.Default value
Constraints
changes_scheduled_at, reactivate_from, or trial_end.Impacts
taxes[] and line_item_taxes[] are computed based on the tax configuration as of invoice_date.create_pending_invoices is set to true, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date.The new start date of a future subscription.
Prerequisites
status must be future.The time at which the trial has ended or will end for the subscription. Set to 0 to have no trial period.
Constraints
status is future, in_trial, or cancelled.changes_scheduled_at or start_date.cancelled or in_trial status. Do this to keep a record of when the trial ended.Impact
trial_end is backdated, the subscription immediately goes into active or non_renewing status.The number of subscription billing cycles to invoice in advance.\nIf a new term is started for the subscription due to this API call, then terms_to_charge\nis inclusive of this new term. See description for the force_term_reset\nparameter to learn more about when a subscription term is reset.
If the subscription status\nis cancelled\nand it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.\nNote:\nIt is recommended not to pass this parameter along with changed_scheduled_at.\nreactivate_from\ncan be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
changes_scheduled_at cannot be earlier than 14th February.The list of coupons to be applied to this subscription. You can provide coupon IDs or coupon codes.
\nNote
changes_scheduled_at is in the past, you can use currently available coupons even if those coupons were not available on the date of the change.Determines whether the provided coupon_ids replace or add to the existing coupons on the subscription.
Default value
false (the provided coupons are added to the existing coupons)When this subscription change is set to occur in the middle of the subscription term, prorate determines whether prorated credits and charges are created for the change.
true: Prorated credits or charges are created as applicable for this change.false: The subscription is changed without creating any credits or charges.Default value
\nThe value configured in the site settings is used when not provided.Constraints
\nIf you setprorate to true for a change made mid-term in the billing cycle, credits are not created if all of the following were true for a previous change in the same billing term:prorate set to false.Deprecated
change_option, then change_option takes precedence.This parameter has the same effect as setting the change_option parameter to end_of_term.
Forces the subscription term to start from the date of the subscription change when updating to a plan-item price with the same billing period as the current plan-item price.
\nDefault value
falseConstraints
end_of_term is false.force_term_reset, you must also pass invoice_usages with the same value when all of the following site configuration settings are enabled:\nDetermines whether to reactivate a cancelled subscription when making this API request.
\nDefault value
true when subscription_items or coupons are provided, unless explicitly set to false.Required if
status is cancelled and you want to reactivate it.The Chargebee payment token generated by Chargebee JS.
\nNote:\nThe payment token created via Chargebee JS uses the gateway selected through Smart Routing.\nExplicitly passing a gateway_id\nin this API call will not override the gateway associated with the token.
If true\n, ignores the hierarchy relationship\nand uses customer as payment and invoice owner.
The date-time at which the subscription change is to happen or has happened.
\nDeprecated for scheduling changes
Required if
change_option is set to specific_date.Constraints
reactivate_from.Backdated changes
\nchanges_scheduled_at can be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:status is active, cancelled, or non_renewing.current_term_start.Specifies when the subscription change takes effect.
\nConstraints
\nRegardless of the value of thechange_option parameter, the following parameters always take effect immediately:auto_collectionshipping_addresspo_numberSee also
Deprecated\nThis option is deprecated; use the Create a ramp API instead.
The change is carried out at the end of the current billing cycle of the subscription.
\n* specific_date -Deprecated for scheduling changes\nThis option is deprecated for scheduling changes to occur at a future date-time, use the Create a ramp API instead.
Executes the change on a specified date. The change occurs as of the date-time defined in changes_scheduled_at.
The subscription change takes effect immediately.
", "enum" : [ "immediately", "end_of_term", "specific_date" ], "example" : null }, "contract_term_billing_cycle_on_renewal" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The period of time by which the first billing term after trial is extended free of charge. The value is expressed in the time unit specified by free_period_unit. For example, 3 with free_period_unit = month adds 3 free months to the first paid term when the subscription becomes active.
The time unit for free_period.
Constraints
\nMust be equal to or lower than theperiod_unit of the plan item price of the subscription.Charge based on week(s)
\n* month -Charge based on month(s)
\n* day -Charge based on day(s)
\n* year -Charge based on year(s)
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "create_pending_invoices" : { "type" : "boolean", "deprecated" : false, "description" : "Determines whether invoices for this subscription are generated with a pending status.
Prerequisites
Default behavior
true automatically when the subscription has item prices that belong to metered items.Use case
Determines whether to invoice the overages for metered items during the subscription change.
\nPrerequisites
Constraints
invoice_usages, you must also pass force_term_reset with the same value when all of the following site configuration settings are enabled:\nThe gateway account in which these card details are stored.
\nRequired when
card parameter.The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nIf you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, then XI\n(the code for United Kingdom - Northern Ireland\n) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's devicePass these parameters to create a new payment_source using an authorized payment_intent. This is the recommended way to create a payment source in Chargebee for both Strong Customer Authentication (SCA) (i.e. 3D-Secure) and non-SCA flows. See use cases to learn more.
Identifier for the payment_intent resource. If you provide this parameter, you do not need to pass other payment_intent parameters.
Prerequisites
payment_intent.status must be authorized.The payment method type.
\nDefault value
cardcard
\n* twint -Payments made via Twint
\n\n* dotpay -dotpay
\n* faster_payments -Faster Payments
\n\n* upi -upi
\n* kbc_payment_button -KBC Payment Button
\n* payme -Payments made via PayMe
\n\n* google_pay -google_pay
\n* paypal_express_checkout -paypal_express_checkout
\n* pix -Pix
\n\n* klarna_pay_now -Klarna Pay Now
\n\n* ideal -ideal
\n* boleto -boleto
\n* wechat_pay -Payments made via WeChat Pay.
\n\n* after_pay -Payments made via Afterpay
\n\n* grab_pay -Payments made via GrabPay
\n\n* direct_debit -direct_debit
\n* sepa_instant_transfer -Sepa Instant Transfer
\n\n* bancontact -bancontact
\n* kakao_pay -Payments made via Kakao Pay.
\n\n* swish -Payments made via Swish
\n\n* go_pay -Payments made via GoPay
\n\n* trustly -Trustly
\n* naver_pay -Payments made via Naver Pay.
\n\n* stablecoin -Payments made via Stablecoin.
\n\n* venmo -Venmo
\n\n* alipay -Payments made via Alipay.
\n\n* pay_to -PayTo
\n\n* pay_co -Payments made via PayCo
\n\n* cash_app_pay -Payments made via Cash App Pay.
\n\n* netbanking_emandates -netbanking_emandates
\n* payconiq_by_bancontact -Payments made via Payconiq by Bancontact.
\n\n* electronic_payment_standard -Electronic Payment Standard
\n* pay_by_bank -Pay By Bank
\n* apple_pay -apple_pay
\n* online_banking_poland -Online Banking Poland
\n\n* giropay -giropay
\n* sofort -sofort
\n* amazon_payments -Amazon Payments
\n* revolut_pay -Payments made via Revolut Pay.
\n", "enum" : [ "card", "ideal", "sofort", "bancontact", "google_pay", "dotpay", "giropay", "apple_pay", "upi", "netbanking_emandates", "paypal_express_checkout", "direct_debit", "boleto", "venmo", "amazon_payments", "pay_to", "faster_payments", "sepa_instant_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "wechat_pay", "alipay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna" ], "example" : null }, "reference_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.\n", "maxLength" : 65000, "example" : null }, "additional_information" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
Determines whether the customer is e-invoiced. When set to true\nor not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (billing_address.country\n). When set to false\n, the customer is not e-invoiced even if e-invoicing is enabled for their country.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Action to be taken when the contract term completes.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
Maximum amount of excess payments\nthat can be applied to any single invoice associated with this subscription. Set to -1 to auto-apply without limit, 0 to prevent auto-application, or any positive value to define the maximum amount that can be applied.
Maximum amount of refundable credits\nthat can be applied to any single invoice associated with this subscription. Set to -1 to auto-apply without limit, 0 to prevent auto-application, or any positive value to define the maximum amount that can be applied.
The list of item prices to add or update in the subscription.
\nNote\nSee replace_items_list for more details.
The quantity of the item price purchased.
\nPrerequisites
pricing_model must be per_unit, stairstep, or tiered.The decimal representation of the quantity of the item purchased.
\nPrerequisites
pricing_model must be per_unit, stairstep, or tiered.The price or per-unit price of the item. Overrides the price set for the item price.
\nPrerequisites
pricing_model of the item price must be flat_fee or per_unit.Default value
changes_scheduled_at is in the past and unit_price is not passed, the item price's current unit price is considered even if the item price did not exist on the date.The decimal representation of the price or per-unit price of the item. Overrides the price set for the item price.
\nPrerequisites
Default value
changes_scheduled_at is in the past and unit_price_in_decimal is not passed, the item price's current unit price is considered even if the item price did not exist on the date.Constraints
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_creation -the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* immediately -The item is charged immediately on being added to the subscription.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
Specifies how to manage charges or credits for the addon item price during this subscription update.
\nPrerequisites
item_type = addon.pricing_model = per_unit.Default value
prorate parameter > item_price.proration_type > site-wide proration setting.Constraints
subscription.subscription_items attributes and automatically applies to any additional changes to the addon during the current term. It's removed from the subscription attributes at the next term renewal. You can't alter this parameter's value within the current term via later API calls.Don't apply any charges or credits for the addon.
\n* full_term -Charge the full price of the addon or give the full credit. Don't apply any proration.
\n* partial_term -Prorate the charges or credits for the rest of the current term.
", "enum" : [ "full_term", "partial_term", "none" ], "example" : null }, "example" : null }, "usage_accumulation_reset_frequency" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "Specifies the frequency at which the usage counter needs to be reset.\n\\* subscription_billing_frequency -\n\nAccumulates usage until the subscription's billing frequency ends.\n\\* never -\n\nAccumulates usage without ever resetting it.\n", "enum" : [ "never", "subscription_billing_frequency" ], "example" : null }, "example" : null } }, "required" : [ "item_price_id" ], "example" : null }, "discounts" : { "type" : "object", "deprecated" : false, "description" : "Parameters for discounts\n", "properties" : { "apply_on" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* one_time -The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 7 days.
\n* year -A period of 1 calendar year.
\n* day -A period of 24 hours.
\n* month -A period of 1 calendar month.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
The operation to be carried out for the discount.
\n\n* remove -The discount (given by discounts[id]\n) is removed from the subscription. Subsequent invoices will no longer have the discount applied. Tip:\nIf you want to replace a discount, remove\nit and add\nanother in the same API call.
The discount is attached to the subscription.
", "enum" : [ "add", "remove" ], "example" : null }, "example" : null }, "id" : { "type" : "array", "description" : "The id\nof the discount\nto be removed. This parameter is only relevant when discounts[operation_type]\nis remove\n.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null }, "credit_notes" : { "type" : "array", "description" : "Resource object representing credit_note
", "items" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/remove_coupons" : { "post" : { "summary" : "Remove coupons", "description" : "Caution\nIf there are scheduled ramps for the subscription, this operation can move the ramps to the draft status when it conflicts with any upcoming ramps.
Removes coupons associated with the subscription. If the param coupon_ids\nis not specified, all the coupons linked to the subscription are be removed.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/resume" : { "post" : { "summary" : "Resume a subscription", "description" : "Note: This operation optionally supports 3DS verification flow. To achieve the same, create the Payment Intent and pass it as input parameter to this API.
This API is used to resume a paused subscription. On resumption the subscription will be activated and any applicable charges will be initiated.
You could schedule the resumption by passing specific_date parameter in resume_option. If scheduled, the subscription will be resumed on the specific_date and moved to Active state.
For in-term resumption, unless there are scheduled changes, unbilled charges will not be charged.
What is an "in-term resumption"?\nAn "in-term resumption" is when the pause and resumption happens within the billing term of the subscription.
Example : A subscription was billed from 1st to 31st of a month. It was paused on the 20th and resumed before 31st. This is an in-term resumption.
Specifying unpaid_invoices allows you to close invoices of the subscription which have amounts due. The invoices are chosen for payment collection after applying the available credits and excess payments.
If you specify schedule_payment_collection, Chargebee will try to collect payments for overdue invoices, provided that auto_collection is enabled for the subscription. The available payment method is charged. Upon successful payment, the payment_succeeded event is triggered. If the payment collection fails, no further attempts will be made to collect payment on the invoices.
Note: If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are cancelled, these invoices will not be selected for collection.
Warning
This API will return an error when multi-frequency billing is enabled.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/cancel_for_items" : { "post" : { "summary" : "Cancel subscription for items", "description" : "Cancels the specified subscription.
cancelled or transferred.contract_term_cancel_option instead of cancel_option.Subscription
cancel_option.contract_term_cancel_option.status changes to cancelled when canceled.cancel_option is specified as end_of_term, or if contract_term_cancel_option is specified as end_of_subscription_billing_term, the subscription status changes to non_renewing and the subscription billing_cycles becomes 0.Contract Terms
contract_term_cancel_option.Ramps
If ramps are scheduled for the subscription, this operation deletes any ramps that are set to become effective on or after the subscription's cancellation date-time.
Before calling this API, perform the following checks:
status is not cancelled or transferred.contract_term_cancel_option instead of cancel_option.Cancel a subscription with a contract term
If the subscription has a contract term, you can use the following parameters with this API:
contract_term_cancel_optioncancel_atcredit_option_for_current_term_chargesunbilled_charges_optionaccount_receivables_handlingrefundable_credits_handlingDetermines when to cancel the subscription.
\nThis parameter is not applicable.
\n* end_of_billing_term -This is used to cancel a subscription either at the end of the advance term, if it's billed for future renewals or at the end of its current billing cycle
\n* end_of_term -This is used to cancel a subscription at the end of the current billing cycle
\n* immediately -This is used to cancel the subscription with immediate effect
\n* specific_date -This is used to cancel a subscription on a specified date. The change occurs as of the date/time defined in cancel_at
(Deprecated) Use cancel_option instead.\nApplicable only when the subscription does not have contract terms.\nSet this to true if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription status changes to non_renewing.
Specifies the date and time when the subscription should be canceled. Do not use this parameter when end_of_term is set to true.
Applicable only when contract_term_cancel_option is specific_date. Specifies the date and time to cancel the subscription and contract term.
You can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:
\ncurrent_term_start.cancel_at cannot be earlier than February 14.Specifies how to handle credits for current term charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle credits for current term charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
No credits notes are created.
\n* full -Credits are issues for the full value of the current term charges.
\n* prorate -Prorated credits are issued.
", "enum" : [ "none", "prorate", "full" ], "example" : null }, "unbilled_charges_option" : { "type" : "string", "deprecated" : false, "description" : "Specifies how to handle unbilled charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle unbilled charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
An invoice is generated immediately with the unbilled charges.
\n* delete -The unbilled charges are deleted.
", "enum" : [ "invoice", "delete" ], "example" : null }, "account_receivables_handling" : { "type" : "string", "deprecated" : false, "description" : "Specifies how to handle past due invoices when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle past due invoices when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
No action is taken.
\n* write_off -Applies excess payments and refundable credits to past due invoices. Any remaining balance is written off.\nNote: The credit note for the write-off is not included in the API response.
\n* schedule_payment_collection -Applies excess payments and refundable credits to past due invoices. If any amount remains and auto_collection\nis on\n, the remaining amount is automatically charged to the available payment method.
Specifies how to handle refundable credits when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle refundable credits when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
Refunds remaining credits after applying them to any past due invoices.
\n* no_action -No action is taken.
", "enum" : [ "no_action", "schedule_refund" ], "example" : null }, "contract_term_cancel_option" : { "type" : "string", "deprecated" : false, "description" : "Required when the subscription has a contract term. Determines when to cancel the subscription along with the contract term.
\n* terminate_immediately -Cancels the subscription and contract term immediately. Sets the contract term's status to terminated and collects any termination fee, if applicable.\nTo specify the termination fee, include a single object in the subscription_items array. If not specified, the default termination fee is applied (if configured).
Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term.
\n* specific_date -Cancels the subscription and contract term on the date specified by cancel_at. Sets action_at_term_end to cancel.\nNote: Contact Chargebee Support to enable this option for your Chargebee site.
Cancels the subscription and contract term at the end of the current billing cycle. Sets action_at_term_end to cancel.\nNote: Contact Chargebee Support to enable this option for your Chargebee site.
The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices\nis true\n, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes\nand line_item_taxes\nare computed based on the tax\nconfiguration as of invoice_date.\nWhen passing this parameter, the following prerequisites must be met:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.cancel_at.\n.Indicates whether the subscription should be decommissioned when it is canceled. If set to true all subscription operations will be disabled except deletion.
Note: Decommission operation is irreversible. Once set to true it cannot be updated to false and thus subscription will remain decommissioned permanently.
The unique id\nof the charge item_price that represents the termination fee.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null }, "credit_notes" : { "type" : "array", "description" : "Resource object representing credit_note
", "items" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/regenerate_invoice" : { "post" : { "summary" : "Regenerate an invoice", "description" : "Use this API to regenerate the current-term invoice for a subscription. The new invoice will contain non-metered charges from the current term and metered charges from the previous term.\nIf a customer was billed incorrectly, because of a wrong plan, price, or tax configuration, you can first void or delete the erroneous invoice, update the subscription or usage records, and then run this operation to issue the corrected invoice.
Before regenerating an invoice, ensure the following conditions are met:
status must be active or non_renewing.metered subscribed items for the current term.metered items for the previous term.Current-Term Invoice
Chargebee does not modify the voided or deleted invoice for the current term. Instead, it creates a new invoice.
The new invoice includes:
The new invoice does not include:
If every charge for the current-term has a value of zero, and your site is configured to hide zero-value line items, the invoice is not generated.
If you delete the original invoice, the associated usage data is also deleted. To ensure accurate billing for metered items, add or bulk import usage records before regenerating the invoice.
Payment Collection
If auto-collection is on, Chargebee attempts to collect payment for the regenerated invoice. If the payment collection fails, the invoice regeneration also fails.
Note: Chargebee applies any customer balances, such as unapplied payment from the voided invoice, before attempting to collect the remaining amount.
Order
Any orders associated with the invoice are regenerated automatically when the invoice is regenerated.
Before calling this API, perform the following checks:
status is active or non_renewing.date_from and date_to parameters, ensure that their values fall within the range defined by subscription.current_term_start and subscription.current_term_end.Whether the charges should be prorated according to the term specified by date_from\nand date_to.\nShould not be passed without date_from\nand date_to\n.
Only applicable when Consolidated Invoicing\nis enabled for the customer. Set to false\nto leave the current term charge for the subscription as unbilled.\nOnce you have done this for all suitable subscriptions of the customer, call Create an invoice for unbilled charges\nto invoice them.
Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions" : { "get" : { "summary" : "List subscriptions", "description" : "Returns a list of subscriptions meeting **all**\nthe conditions specified in the filter parameters below.\n", "operationId" : "list_subscriptions", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Indicates whether to include deleted objects in the list. The deleted objects have the attribute deleted\nas true\n.
optional, timestamp(UTC) in seconds filter
\nTime at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.\nSupported operators :\nafter, before, on, between, is_present
Example →\nactivated_at[after] = "1435054328"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1435054328", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "next_billing_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\nThe date/time at which the next billing for the subscription happens. This is usually right after current_term_end\nunless multiple subscription terms were invoiced in advance using the terms_to_charge\nparameter.\nSupported operators :\nafter, before, on, between
Example →\nnext_billing_at[after] = "1435054328"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1435054328", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "cancelled_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter\n\nTime at which subscription was cancelled or is set to be cancelled.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*cancelled_at\\[after\\] = \"1435054328\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1435054328", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "has_scheduled_changes", "in" : "query", "description" : "optional, boolean filter
\nIf true\n, there are subscription changes scheduled on next renewal. Possible values are : true, false
Supported operators :\nis
\nExample →\nhas_scheduled_changes[is] = "true"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "true", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "updated_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\nTo filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[after] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "offline_payment_method", "in" : "query", "description" : "optional, enumerated string filter\n\nThe preferred offline payment method for the subscription. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*offline_payment_method\\[is_not\\] = \"cash\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "cash", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\n", "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\n", "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\n", "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ], "pattern" : "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\n", "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ], "pattern" : "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\]$", "example" : null } } } }, { "name" : "auto_close_invoices", "in" : "query", "description" : "optional, boolean filter
\nSet to false\nto override for this subscription, the site-level setting\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level.\nPossible values are : true, false
Supported operators :\nis
\nExample →\nauto_close_invoices[is] = "true"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "true", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "override_relationship", "in" : "query", "description" : "optional, boolean filter
\nIf true\n, ignores the hierarchy relationship\nand uses customer as payment and invoice owner. Possible values are : true, false
Supported operators :\nis
\nExample →\noverride_relationship[is] = "false"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "false", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\ncreated_at, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"created_at\"*\n\nThis will sort the result based on the 'created_at' attribute in ascending(earliest first) order.\n", "required" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "asc" : { "type" : "string", "enum" : [ "created_at", "updated_at" ], "example" : null }, "desc" : { "type" : "string", "enum" : [ "created_at", "updated_at" ], "example" : null } }, "example" : null } }, { "name" : "business_entity_id", "in" : "query", "description" : "optional, string filter\n\nThe unique ID of the\n[business entity](/docs/api/advanced-features)\nof this subscription. This is always the same as the\n[business entity](/docs/api/subscriptions/subscription-object#customer_id)\nof the customer.\n\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*business_entity_id\\[is_not\\] = \"business_entity_id\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null } } } }, { "name" : "channel", "in" : "query", "description" : "optional, enumerated string filter\n\nThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*channel\\[is_not\\] = \"APP STORE\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "APP STORE", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null } } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card" } }, "required" : [ "customer", "subscription" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/move" : { "post" : { "summary" : "Move a subscription", "description" : "Moves a subscription from one customer to another asynchronously. All related resources such as unbilled_charge, invoice, credit_note, and transaction are also moved to the new customer.
After moving, Chargebee adds a comment to the original customer resource to document the move, including the to_customer_id and the ids of all the resources transferred to the destination customer.
Warning
auto_collection is on, it might fail after this operation. Refer to the warning in copy_payment_source for details.customer resource that is within an account hierarchy relationship.payment_due, pending, or posted associated with the subscription.credit_note resources with the statuses adjusted or refund_due should be associated with the subscription.If the above prerequisites are met, the API call returns a 200 OK response containing the subscription resource as is. However, the actual move operation can take up to five minutes to complete.
To know whether the operation was successful, we recommend that you watch for the subscription_changed event and see if subscription.customer_id has changed.
Note:\nResources linked to the original customer such as unbilled_charge\n, invoice\n, credit_note\n, and transaction\nbut not\nlinked to the subscription being moved, are not\nmoved to the destination customer by this operation.
Specifies the unique ID of the customer resource to which the subscription will be moved.
Note:\nIf there are multiple business entities\n, the customer.business_entity_id\nof the destination customer must match the subscription.business_entity_id.
When true:\nIf the subscription has an associated payment_source:
payment_source resource is created.Note:\nDeleting any copy of the payment_source\nalso deletes the other copies and the details stored at the payment gateway.
When false:\nNo new payment source is created for the subscription. Moreover, if a payment_source is already linked to the subscription, it gets removed, meaning the subscription.payment_source_id is cleared.
Warning:\nWhen copy_payment_source\nis false\nand if subscription.auto_collection\nis enabled, auto-collection will fail, in turn preventing subscription renewal. To prevent auto-collection failure, link a payment source\nto the subscription after this operation.
Resource object representing subscription
" } }, "required" : [ "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/import_for_items" : { "post" : { "summary" : "Import subscription for Items", "description" : "Imports a subscription for an existing customer.
Use this operation when migrating subscriptions from another billing system.
If you are calling this operation on your live site, ensure you have requested Support to enable it; otherwise the API may return an "API not enabled" error.
Subscription
A subscription is created for the customer with the details provided in the request.
Invoice and payment
When create_current_term_invoice is true, an invoice is created for the current term.
Specifies the IDs of coupons\nto be marked as exhausted. This parameter accepts a list of IDs, which must correspond to coupons with a duration_type\nof one_time.\nEnsure that the IDs included in this parameter do not match any IDs provided in the coupon_ids\nparameter.
End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than start_date.\nSet it to 0\nto have no trial period.
Defines Net D\nfor the subscription. Net D is the number of days within which any invoice raised for the subscription must be paid.
\nnet_term_days defined at the customer level is considered.\n.End of the current billing term. Subscription is renewed immediately after this. If not given, this will be calculated based on plan billing cycle.
\nNote:
For subscription status: non_renewing, active, and paused, current_term_end is required.
Start of the current billing period of the subscription. This is required when the subscription status\nis paused.\nWhen the status\nis active\nor non_renewing\n, it defaults to the current time.
Start of the trial period for the subscription. When not passed, it is assumed to be current time. When passed for a future\nsubscription, it implies that the subscription goes into in_trial\nwhen it starts.
Time at which the subscription was started. Is null\nfor future\nsubscriptions as it is yet to be started.
The time at which the subscription was activated. A subscription is "activated" when its status changes from any other, to either active or non_renewing.
Constraints
status is active, non_renewing, cancelled, or paused, activated_at must be on or after trial_end or started_at. Additionally, activated_at must be on or before current_term_start.status is in_trial, activated_at must precede trial_start.status as future.When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the paused\nstate, it is the date/time when the subscription was paused.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
Set as true\nif you want an invoice to be created for the subscription.
active or non_renewing status.current_term_start to current_term_end.transaction details to record an offline payment against that invoice.Indicates whether the invoices for this subscription are generated with a pending status. This attribute is set to true automatically when the subscription has item prices that belong to metered items.\nYou can also set this to true explicitly using the create/update subscription operations. This is useful in the following scenarios:
Set to false\nto override for this subscription, the site-level setting\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level\n.
The amount raised for the contract term till the time of importing the subscription. This amount is added to the total_contract_value
The amount raised for the contract term till the time of importing the subscription excluding tax. This amount is added to the total_contract_value_before_tax
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The payment transaction amount.
\nConstraints
create_current_term_invoice is true.The reference number for this transaction. For example, check number when payment_method is check.
Constraints
create_current_term_invoice is true.The date of occurrence of the transaction.
\nConstraints
create_current_term_invoice is true.The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The price or per-unit price of the item. When not provided, the value set for the item price is used.
\nPrerequisites
pricing_model is flat_fee or per_unit.When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price in the subscription to which the discount is to be applied.
\nNote
\nThis parameter is relevant only whenapply_on = specific_item_price.Identifier of the charge item price that was already charged for this subscription.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/retrieve_advance_invoice_schedule" : { "get" : { "summary" : "Retrieve advance invoice", "description" : "**Caution**\n\n* This API will return an error when [multi-frequency billing](/docs/api/subscriptions#subscription-billing-frequencies) is enabled.\n\nRetrieves the *advance_invoice_schedule* for a subscription. Note that this endpoint is only applicable for *schedule_type = specific_dates* or fixed_intervals.\n", "operationId" : "retrieve_advance_invoice", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "advance_invoice_schedules" : { "type" : "array", "description" : "Resource object representing advance_invoice_schedule
", "items" : { "$ref" : "#/components/schemas/AdvanceInvoiceSchedule", "description" : "Resource object representing advance_invoice_schedule" }, "example" : null } }, "required" : [ "advance_invoice_schedules" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/remove_scheduled_cancellation" : { "post" : { "summary" : "Remove scheduled cancellation", "description" : "Removes a scheduled cancellation from a subscription so that it continues billing for the specified number of billing cycles.\nUse this operation when a customer changes their mind about canceling their subscription.
contract_term associated with it.status must be in_trial, active or non_renewing.Subscription
status is in_trial, it does not change.status is not in_trial, it becomes active.subscription.remaining_billing_cycles is set to the value of billing_cycles.contract_term is provided, then a new contract_term is created on the subscription.Before calling this API, perform the following checks:
cancelled_at attribute. It must be set to a future date-time, indicating that a cancellation is scheduled.contract_term attribute is not present.status is in_trial, active or non_renewing.The number of billing cycles the subscription should remain active for after the current billing cycle. The remaining_billing_cycles attribute of the subscription is updated to this value.
Constraints
Default Value
billing_cycles on the subscription's plan item price is used.Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
Action to be taken when the contract term completes.
\n* cancel -Contract term completes and subscription is canceled.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/retrieve_with_scheduled_changes" : { "get" : { "summary" : "Retrieve with scheduled changes", "description" : "Note\nIf the ramps feature is enabled and there is more than one ramp on a subscription, this API will return the subscription with the upcoming ramp applied.
Retrieves a subscription with the scheduled changes applied.\nNote: Only the following attributes are changed
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/reactivate" : { "post" : { "summary" : "Reactivate a subscription", "description" : "Reactivates a canceled subscription.
Use this operation to restore a canceled subscription to an active or in-trial state.
To extend the billing cycles of a non_renewing subscription, use the Remove scheduled cancellation API.
The subscription's current billing term is demarcated by the current_term_start and current_term_end attributes. These attributes are retained even if the subscription is canceled. An "in-term reactivation" happens when the subscription is reactivated on or before current_term_end.
status must be cancelled.If an invoice gets generated during this operation, customer balances such as promotional credits, excess payments, and refundable credits are automatically applied subject to limits set at the site level which can be overridden for subscriptions via subscription.billing_override.
payment_intentUse the payment_intent parameter to create a payment source for the customer. If reactivation generates an invoice and auto_collection is on, Chargebee immediately attempts payment collection using the new payment source.
Note
payment_intent resource by calling the Create a payment intent API.payment_intent object to your frontend and use Chargebee.js to capture the payment source details from the customer. You can use Payment Components to capture the payment source details.payment_intent_updated event. Once the payment_intent.status is authorized, pass the payment_intent.id using the payment_intent[id] parameter in this API call.Providing this parameter indicates that the subscription reactivates with an in_trial status and the trial period ends at the date provided.
Constraints
reactivate_from if reactivate_from is provided.trial_end is backdated, the subscription immediately goes into active or non_renewing status.The number of billing cycles (including the current cycle) this subscription should remain active for. After the billing cycles are exhausted, the subscription is canceled automatically.
\nDefault value
Impact
remaining_billing_cycles attribute of the subscription is updated to one less than the value of this parameter.The date-time at which the subscription was reactivated. When not provided, the subscription is reactivated immediately on calling this API.
\nPrerequisites
Constraints
reactivate_from cannot be earlier than 14th February.trial_end if trial_end is provided.If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_immediately\nonly affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
.
", "example" : null }, "billing_alignment_mode" : { "type" : "string", "deprecated" : false, "description" : "Applicable when calendar billing is enabled and a new *active*\nterm gets started during this operation. Unless specified the configured *default*\nvalue will be used.\n\\* delayed -\n\nSubscription period will be aligned with the configured billing date at the next renewal.\n\\* immediate -\n\nSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly.\n", "enum" : [ "immediate", "delayed" ], "example" : null }, "terms_to_charge" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of subscription billing cycles to invoice in advance.\nIf a new term is started for the subscription due to this API call, then terms_to_charge\nis inclusive of this new term. See description for the force_term_reset\nparameter to learn more about when a subscription term is reset.
The document date displayed on the invoice PDF. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices is true, and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date.
Default value
Constraints
reactivate_from or trial_end.invoice_immediately must be true.The number of billing cycles the new contract term should run for, on contract renewal. This value is used when action_at_term_end is renew.
Constraints
contract_term.action_at_term_end is cancel or evergreen.Default value
billing_cycle or a custom value depending on the site configuration.Action to be taken when the contract term completes.
\nConstraints
billing_cycles must be provided when this parameter is sent.The contract term completes and the subscription continues to renew without a new contract term.
\n* renew -The contract term completes and a new contract term is started for the number of billing cycles specified in contract_term_billing_cycle_on_renewal. The action_at_term_end for the new contract term is set to renew.
Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end during which the customer is barred from canceling the contract term. The customer can cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
Required if
action_at_term_end is renew.Constraints
action_at_term_end is cancel or evergreen.Identifier for the payment_intent resource. If you provide this parameter, you do not need to pass other payment_intent parameters.
Prerequisites
payment_intent.status must be authorized.The payment method type.
\nDefault value
cardcard
\n* twint -Payments made via Twint
\n\n* swish -Payments made via Swish
\n\n* after_pay -Payments made via Afterpay
\n\n* netbanking_emandates -netbanking_emandates
\n* grab_pay -Payments made via GrabPay
\n\n* payconiq_by_bancontact -Payments made via Payconiq by Bancontact.
\n\n* dotpay -dotpay
\n* faster_payments -Faster Payments
\n\n* upi -upi
\n* kbc_payment_button -KBC Payment Button
\n* electronic_payment_standard -Electronic Payment Standard
\n* payme -Payments made via PayMe
\n\n* direct_debit -direct_debit
\n* sepa_instant_transfer -Sepa Instant Transfer
\n\n* bancontact -bancontact
\n* go_pay -Payments made via GoPay
\n\n* pay_by_bank -Pay By Bank
\n* google_pay -google_pay
\n* apple_pay -apple_pay
\n* online_banking_poland -Online Banking Poland
\n\n* trustly -Trustly
\n* naver_pay -Payments made via Naver Pay.
\n\n* stablecoin -Payments made via Stablecoin.
\n\n* giropay -giropay
\n* paypal_express_checkout -paypal_express_checkout
\n* pix -Pix
\n\n* venmo -Venmo
\n\n* klarna_pay_now -Klarna Pay Now
\n\n* alipay -Payments made via Alipay.
\n\n* sofort -sofort
\n* amazon_payments -Amazon Payments
\n* ideal -ideal
\n* kakao_pay -Payments made via Kakao Pay.
\n\n* pay_to -PayTo
\n\n* boleto -boleto
\n* pay_co -Payments made via PayCo
\n\n* revolut_pay -Payments made via Revolut Pay.
\n\n* wechat_pay -Payments made via WeChat Pay.
\n\n* cash_app_pay -Payments 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" ], "example" : null }, "reference_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.\n", "maxLength" : 65000, "example" : null }, "additional_information" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/charge_future_renewals" : { "post" : { "summary" : "Charge Future Renewals", "description" : "Creates a single advance invoice or an advance invoicing schedule for a subscription.
Use this operation to bill future renewals in advance, enabling customers to prepay for upcoming billing cycles.
status must be active.metered item.gift_receiver[customer_id][is] to the customer_id of the subscription and checking if one of the returned objects has gift_receiver.subscription_id matching the id of the subscription.contract_term.action_at_term_end set to cancel.next_billing_at is updated to reflect the end of the last term being invoiced. If all remaining billing cycles are invoiced, next_billing_at is set to null.remaining_billing_cycles is reduced by the number of terms charged.schedule_type is immediate and invoice_immediately = true:\nauto_collection is on for the subscription, the payment for the invoice is collected immediately using the payment source associated with the subscription.schedule_type is immediate and invoice_immediately is false: The charges are added to unbilled_charges for the subscription and invoiced on the next renewal.schedule_type is specific_dates or fixed_intervals:\nThe number of billing cycles to charge, depending on the schedule_type:
schedule_type = immediate: The number of future billing cycles to be invoiced in advance. The invoicing is done for the remaining_billing_cycles of the subscription if that is less than terms_to_charge.schedule_type = fixed_intervals: The number of future billing cycles in one interval. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles of the subscription.Constraints
remaining_billing_cycles of the subscription.Default value
1Whether the charge should be invoiced immediately or added to unbilled_charges.
Prerequisite
invoice_immediately is true and auto_collection is on for the subscription, there must be a valid and active online payment_source associated with the subscription or the customer.Constraints
schedule_type must be immediate.Default value
trueThe type of advance invoice or advance invoicing schedule.
\nDefault value
immediateBill immediately for the number of billing cycles specified by terms_to_charge.
Prerequisite
Invoice on specific dates.
\nPrerequisite
schedule_type = fixed_intervals for the subscription.schedule_type = specific_dates must not exceed 5.Constraints
specific_dates_schedule[date].Invoice at fixed intervals of time.
\nPrerequisite
Constraints
terms_to_chargefixed_interval_schedule[days_before_renewal]fixed_interval_schedule[end_schedule_on]Parameters for fixed_interval_schedule.
\nRequired if
schedule_type is fixed_intervals.Constraint
fixed_interval_schedule array.The number of advance invoices to generate.
\nRequired if
fixed_interval_schedule[end_schedule_on] is set to after_number_of_intervals.Impact
remaining_billing_cycles of the subscription.The number of days before each interval that advance invoices are generated.
\nConstraints
5 days.25 days for 1-month periods.363 days.days_before_renewal should not be provided.Specifies when the advance invoicing schedule ends.
\n* after_number_of_intervals -Advance invoices are generated a specified number of times.
\nConstraint
fixed_interval_schedule[number_of_occurrences].Advance invoices are generated for as long as the subscription is active.
\n* specific_date -The advance invoicing schedule ends on a specific date.
\nConstraint
fixed_interval_schedule[end_date].The date when the advance invoicing schedule ends. Advance invoices are not generated beyond this date.
\nConstraints
fixed_interval_schedule[end_schedule_on] must be set to specific_date.Parameters for specific_dates_schedule.
\nRequired if
schedule_type is specific_dates.Constraints
The number of billing cycles to charge for on the specified date.
\nConstraints
schedule_type must be specific_dates.remaining_billing_cycles of the subscription.Default value
1The date on which the advance invoice should be generated. This is the scheduled date for generating the invoice for the specified number of billing cycles.
\nConstraints
schedule_type must be specific_dates.Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "advance_invoice_schedules" : { "type" : "array", "description" : "Resource object representing advance_invoice_schedule
", "items" : { "$ref" : "#/components/schemas/AdvanceInvoiceSchedule", "description" : "Resource object representing advance_invoice_schedule" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/add_charge_at_term_end" : { "post" : { "summary" : "Add charge at term end", "description" : "Adds a one time charge to the subscription which will be added to the invoice generated at the end of the current term. If there are any applicable coupons in the subscription, an appropriate discount will be applied.\n\nTo collect a charge immediately, [use this API](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge). \nIf any subscription changes happen before the end of the current term, these charges will be collected along with it.\n", "operationId" : "add_charge_at_term_end", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n", "minimum" : 1, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "Description for this charge.\n", "maxLength" : 250, "example" : null }, "amount_in_decimal" : { "type" : "string", "deprecated" : false, "description" : "The decimal representation of the amount for the [one-time charge](https://www.chargebee.com/docs/charges.html#one-time-charges ).\nProvide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/currencies)\nis enabled.\n", "maxLength" : 39, "example" : null }, "avalara_sale_type" : { "type" : "string", "deprecated" : false, "description" : "Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n\\* retail -\n\nTransaction is a sale to an end user\n\\* wholesale -\n\nTransaction is a sale to another company that will resell your product or service to another consumer\n\\* vendor_use -\n\nTransaction is for an item that is subject to vendor use tax\n\\* consumed -\n\nTransaction is for an item that is consumed directly\n", "enum" : [ "wholesale", "retail", "consumed", "vendor_use" ], "example" : null }, "avalara_transaction_type" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n", "example" : null }, "avalara_service_type" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n", "example" : null }, "date_from" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time when the service period for the charge starts.\n", "example" : null }, "date_to" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time when the service period for the charge ends.\n", "example" : null } }, "required" : [ "description" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", "description" : "Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/remove_scheduled_changes" : { "post" : { "summary" : "Remove scheduled changes", "description" : "Removes a scheduled change from a subscription.
To review the scheduled subscription change before removing it, call Retrieve with scheduled changes before calling this API to retrieve the subscription resource with the scheduled change applied.
has_scheduled_changes attribute is true.Subscription
changes_scheduled_at, if set.has_scheduled_changes to false.Invoices
Credit Notes
adjustment: for amount_to_collect on the advance invoice.refundable: for the refundable amount on the advance invoice.Before you call this API, confirm the following:
has_scheduled_changes attribute is true.subscription_id. The response must include exactly one ramp object.Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "credit_notes" : { "type" : "array", "description" : "Resource object representing credit_note
", "items" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/change_term_end" : { "post" : { "summary" : "Change term end", "description" : "Use this endpoint to adjust when a subscription's current term or trial ends without altering the plan or billing frequency. It is helpful when you need to align renewals to a specific calendar date or extend a trial. Future renewals will follow the new date, keeping the subscription cadence intact.
Subscriptions must be in one of the following status values: in_trial, active, non_renewing.
Subscription
Based on the subscription's status, the following updates are made:
in_trial, the trial_end is set to the new date.active, the current_term_end is set to the new date.non_renewing, the upcoming cancellation date is set to the new date.Invoices and Credit Notes
The API can generate unbilled charges, invoice, or credit notes. You can control the behaviour using prorate and invoice_immediately parameters.\nTo preview invoices, credits, and dates, use the Change term end estimate endpoint.
Advance Charges
If there are advance charges, then credit notes are issued for the unused portion of the service period.
Scheduled Pause
If the subscription is scheduled to pause at the end of the current term, the pause date is updated to match the new term end date.
Ramps
If subscription ramps are present, this operation moves them to the draft state. Update and reschedule the ramps as needed to keep them in sync.
The request fails with invalid_state if the subscription is not in one of the trial, active, or non_renewing states. Validate the status before invoking this API.
The time at which the current term should end for this subscription. The value must be a date in the future, i.e. later than current time. The value must not be the same as next_billing_at\n.
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_immediately\nonly affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
.
", "example" : null } }, "required" : [ "term_ends_at" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null }, "credit_notes" : { "type" : "array", "description" : "Resource object representing credit_note
", "items" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/delete" : { "post" : { "summary" : "Delete a subscription", "description" : "Deletes a specified subscription.
This operation schedules the subscription resource for deletion, and it is permanently deleted after a few minutes.\nIf you wish to retain the subscription data but stop further renewals, consider canceling or pausing the subscription instead.
Invoices
Credit notes
All the credit notes belonging to this subscription are deleted.
Transactions
All the transactions belonging to this subscription are deleted.
Usages
All usages belonging to this subscription are deleted.
Usage events
Deleting a subscription does not delete the associated usage events.
Reporting
The numbers in the following reports are modified when a subscription is deleted: Payments, New Revenue, Signups, Activations, Cancellations, and Refunds.
Integrations
Deleting a subscription may affect any third-party integrations you may have with Chargebee Billing. Review all integrations to assess the impact before proceeding.
Before deleting a subscription, ensure the following:
credit_note.applied_credits.cn_id). For all such credit notes, check if the associated subscription (credit_note.subscription_id) is this subscription. If not, use the Remove credit note from an invoice API to remove the credit note allocation.credit_note.allocations.invoice_id). For all such invoices, check if the associated subscription (invoice.subscription_id) is this subscription. If not, use the Remove credit note from an invoice API to remove the allocation.Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/subscription_for_items" : { "post" : { "summary" : "Create subscription for Items", "description" : "Note:\nThis endpoint optionally supports 3DS. To use it create\na payment_intent\nand provide it via this endpoint.
Creates a new subscription for an existing customer in Chargebee. Any available credits and excess payments for the customer are automatically applied on the invoice.
The unique ID of the business entity this subscription should be linked to. Applicable only when multiple business entities have been created for the site. This must be the same as the business entity of the {customer_id} for the operation to be successful.
Note
An alternative way of passing this parameter is by means of a custom HTTP header.
End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than start_date.\nSet it to 0\nto have no trial period.
Specifies the number of billing cycles for the subscription. The behavior of the subscription after the billing cycles have completed depends on whether the subscription is on a contract term or not.
\nbilling_cycles is not provided, then the billing cycles set for the plan-item price is used. Moreover, once the billing_cycles have completed, the subscription cancels.billing_cycles is mandatory. Moreover, once the billing_cycles have completed, the behavior of the subscription is determined by the contract_term[action_at_term_end] parameter.Defines Net D\nfor the subscription. Net D is the number of days from invoice.date until payment for the invoice is due.
net_term_days defined at the customer level is considered.\n.The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
\nstart_date cannot be earlier than 14th February.\n.If true\n, ignores the hierarchy relationship\nand uses customer as payment and invoice owner.
The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices\nis set to true\n, and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes\nand line_item_taxes\nare computed based on the tax configuration as of invoice_date.\nWhen passing this parameter, the following prerequisites must be met:
invoice_date must be in the past.start_date.invoice_immediately is true.\n.If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_immediately\nonly affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
.
", "example" : null }, "replace_primary_payment_source" : { "type" : "boolean", "default" : true, "deprecated" : false, "description" : "Indicates whether the primary payment source should be replaced with this payment source.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n", "example" : null }, "free_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The period of time by which the first term of the subscription is extended free of charge. The value is expressed in the time unit specified by free_period_unit. For example, 3 with free_period_unit = month adds 3 free months to the first term of the subscription.
The time unit for free_period.
Constraints
\nMust be equal to or lower than theperiod_unit of the plan item price of the subscription.Charge based on week(s)
\n* month -Charge based on month(s)
\n* day -Charge based on day(s)
\n* year -Charge based on year(s)
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "contract_term_billing_cycle_on_renewal" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
Indicates whether the invoices for this subscription are generated with a pending status. This attribute is set to true automatically when the subscription has item prices that belong to metered items.\nYou can also set this to true explicitly using the create/update subscription operations. This is useful in the following scenarios:
Set to false\nto override for this subscription, the site-level setting\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level\n.
If you want to bill the usages from the previous billing cycle, set this parameter to true. This is useful if the subscription has moved from another system into Chargebee and you haven't closed the previous cycle's invoice yet. This creates a pending invoice immediately on subscription creation, to which you can add usages for the previous cycle.\nIf any non-metered items are present for the current term, they're also added to this pending invoice. As with all pending invoices, this invoice is also closed automatically or via an API call. This parameter can be passed only when the create_pending_invoices is true\n.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceAction to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
Maximum amount of excess payments\nthat can be applied to any single invoice associated with this subscription. Set to -1 to auto-apply without limit, 0 to prevent auto-application, or any positive value to define the maximum amount that can be applied.
Maximum amount of refundable credits\nthat can be applied to any single invoice associated with this subscription. Set to -1 to auto-apply without limit, 0 to prevent auto-application, or any positive value to define the maximum amount that can be applied.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "example" : null }, "usage_accumulation_reset_frequency" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "Specifies the frequency at which the usage counter needs to be reset.\n\\* subscription_billing_frequency -\n\nAccumulates usage until the subscription's billing frequency ends.\n\\* never -\n\nAccumulates usage without ever resetting it.\n", "enum" : [ "never", "subscription_billing_frequency" ], "example" : null }, "example" : null } }, "required" : [ "item_price_id" ], "example" : null }, "discounts" : { "type" : "object", "deprecated" : false, "description" : "Parameters for discounts\n", "properties" : { "apply_on" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/import_unbilled_charges" : { "post" : { "summary" : "Import unbilled charges", "description" : "Imports one or more [unbilled charges](/docs/api/unbilled_charges) into an existing subscription. Use this operation to add usage-based or other unbilled charges recorded in external systems to the subscription. \n\n### Prerequisites \\& Constraints\n\nIf you are trying to use this operation on your live site, ensure you have requested [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support) to enable it, otherwise the API will return an \"API not enabled\" error. \n\n### Impacts\n\n**Invoicing** \n* Unbilled charges on the subscription are automatically invoiced on the next renewal.\n* You can also invoice unbilled charges on-demand using the [Create an invoice for unbilled charges API](/docs/api/unbilled_charges/create-an-invoice-for-unbilled-charges). \n**Accounting Integrations** \nImported unbilled charges will not sync with your [accounting integration](https://www.chargebee.com/docs/billing/2.0/integrations/finance-integration-index) until they are invoiced.\n", "operationId" : "import_unbilled_charges", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "unbilled_charges" : { "type" : "object", "deprecated" : false, "description" : "Parameters for unbilled_charges\n", "properties" : { "id" : { "type" : "array", "description" : "Uniquely identifies an unbilled charge.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 40, "example" : null }, "example" : null }, "date_from" : { "type" : "array", "description" : "Start date of this charge.\n", "items" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "example" : null }, "date_to" : { "type" : "array", "description" : "End date of this charge.\n", "items" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "example" : null }, "entity_type" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "Specifies the modelled entity this line item is based on.\n\\* plan -\n\nIndicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\nid\n\\* charge_item_price -\n\nIndicates that this line item is based on charge Item Price\n\\* addon_item_price -\n\nIndicates that this line item is based on addon Item Price\n\\* plan_setup -\n\nIndicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\nid\n\\* adhoc -\n\nIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n\\* addon -\n\nIndicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\nid\n\\* plan_item_price -\n\nIndicates that this line item is based on plan Item Price\n", "enum" : [ "adhoc", "plan_item_price", "addon_item_price", "charge_item_price" ], "example" : null }, "example" : null }, "entity_id" : { "type" : "array", "description" : "The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "description" : { "type" : "array", "description" : "Detailed description about this charge.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "example" : null }, "unit_amount" : { "type" : "array", "description" : "Unit amount of the charge item.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "quantity" : { "type" : "array", "description" : "Quantity of the item which is represented by this charge.\n", "items" : { "type" : "integer", "format" : "int32", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "Total amount of this charge. Typically equals to unit amount x quantity.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "unit_amount_in_decimal" : { "type" : "array", "description" : "The decimal representation of the amount for the charge, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
The type of deduction and the amount to which it is applied.
\n* document_level_coupon -The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a promotional credit\napplied to the invoice.
", "enum" : [ "item_level_coupon", "document_level_coupon", "item_level_discount", "document_level_discount" ], "example" : null }, "example" : null }, "entity_id" : { "type" : "array", "description" : "When the deduction is due to a coupon\n, then this is the id\nof the coupon. Is required when discounts[entity_type]\nis item_level_coupon\nor document_level_coupon\n.
The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "unbilled_charges" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/remove_scheduled_resumption" : { "post" : { "summary" : "Remove scheduled resumption", "description" : "If the subscription is in **Paused** state and is scheduled to resume on a specific_date, this API can be used to remove the scheduled resumption. When the scheduled resumption is removed, the subscription will remain **Paused**. \n**Warning**\nThis API will return an error when [multi-frequency billing](/docs/api/subscriptions) is enabled.\n", "operationId" : "remove_scheduled_resumption", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}" : { "get" : { "summary" : "Retrieve a subscription", "description" : "Retrieves a subscription.\n", "operationId" : "retrieve_a_subscription", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/import_contract_term" : { "post" : { "summary" : "Import contract term", "description" : "Imports an active or historical contract term for a subscription.
Use this operation to import contract terms when migrating subscriptions from another billing system, or to add historical contract term data for existing subscriptions. You can import both active contract terms (currently running) and historical contract terms (completed, canceled, or terminated).
remaining_billing_cycles must be set).Contract term
contract_term resource is created and associated with the subscription.total_contract_value is calculated as the sum of the contract estimate and the total_amount_raised parameter.contract_end date is calculated based on the contract_start date and the billing_cycle parameter.remaining_billing_cycles attribute. If it is not set, the subscription is set to forever renewal. Update the subscription to a fixed billing cycle before importing a contract term.contract_start and contract_end dates don't overlap with any existing contract term for the subscription.The number of billing cycles the new contract term should run for when the contract term renews. This value is used when action_at_term_end is renew or renew_once.
Constraints
action_at_term_end is cancel or evergreen.Default value
billing_cycle or a custom value depending on the site configuration.The date when the contract term was created.
\nRequired if
status is active.Constraints
status is future.contract_start.Default value
contract_start if not provided.The start date of the contract term.
\nConstraints
contract_end.status is future.created_at.The end date of the contract term.
\nRequired if
status is not active (for historical contract terms).Constraints
status is active (it is calculated automatically).contract_start.Current status of the contract term. Use active for currently running contract terms, or completed, cancelled, or terminated for historical contract terms.
An actively running contract term.
\nPrerequisite
status must be future, in_trial, active, or non-renewing.The contract term has run its full duration.
\n* cancelled -The contract term was ended because a change in the subscription caused a subscription term reset, or the subscription was canceled due to non-payment.
\n* terminated -The contract term was terminated ahead of completion.
", "enum" : [ "active", "completed", "cancelled", "terminated" ], "example" : null }, "total_amount_raised" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "The amount raised for the contract term up to the time of importing the subscription. This amount is added to the contract estimate to calculate the total_contract_value for active contract terms.
Required if
status is active.Constraints
status is not active.The amount raised for the contract term up to the time of importing the subscription, excluding tax. This amount is added to the contract estimate to calculate the total_contract_value_before_tax for active contract terms.
Required if
status is active and pre-tax TCV is enabled on the site.Constraints
status is not active.The sum of the totals of all invoices raised as part of the contract term.\nFor active contract terms, this is a predicted value calculated as the sum of the contract estimate and total_amount_raised.
Required if
status is not active (for historical contract terms).Constraints
status is active (it is calculated automatically).The total amount of revenue expected to be generated from the contract term, calculated as the sum of all invoices raised during the term, excluding taxes. For active contract terms, this is calculated as the sum of the contract estimate (before tax) and total_amount_raised_before_tax.
Required if
status is not active and pre-tax TCV is enabled on the site (for historical contract terms).Constraints
status is active (it is calculated automatically).The number of billing cycles of the subscription that the contract term covers.
\nRequired if
status is active.Constraints
remaining_billing_cycles when the subscription status is active or non-renewing.Default value
1 if not provided.Action to be taken when the contract term completes.
\n* evergreen -The contract term completes and the subscription continues to renew without a new contract term.
\n* renew_once -The contract term completes and a new contract term is started for the number of billing cycles specified in contract_term_billing_cycle_on_renewal. The action_at_term_end for the new contract term is set to cancel, so the subscription is canceled when the new contract term completes.
The contract term completes and the subscription is canceled.
\n* renew -The contract term completes and a new contract term is started for the number of billing cycles specified in contract_term_billing_cycle_on_renewal. The action_at_term_end for the new contract term is set to renew.
The number of days before contract_end during which the customer is barred from canceling the contract term. The customer can cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
Required if
action_at_term_end is renew or renew_once.Constraints
action_at_term_end is cancel or evergreen.Resource object representing contract_term
" } }, "required" : [ "contract_term" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/override_billing_profile" : { "post" : { "summary" : "Override Billing Profile", "description" : "Assigns the payment source and sets auto collection state for the subscription. \nWhen you don't pass any input param for this API, payment source and auto collection for the subscription will be the same as the customer's default settings.\n", "operationId" : "override_billing_profile", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "payment_source_id" : { "type" : "string", "deprecated" : false, "description" : "Unique identifier of the payment source to be attached to this subscription.\n", "maxLength" : 40, "example" : null }, "auto_collection" : { "type" : "string", "deprecated" : false, "description" : "Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.\n\\* off -\n\nAutomatic collection of charges will not be made for this subscription. Use this for offline payments.\n\\* on -\n\nWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n", "enum" : [ "on", "off" ], "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/remove_scheduled_pause" : { "post" : { "summary" : "Remove scheduled pause", "description" : "If the subscription is in **Active** or **Non Renewing** state and is also scheduled to pause at the end_of_term/specific_date, this API can be used to remove the scheduled pause. \n**Warning**\nThis API will return an error when [multi-frequency billing](/docs/api/subscriptions) is enabled.\n", "operationId" : "remove_scheduled_pause", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/edit_advance_invoice_schedule" : { "post" : { "summary" : "Edit Advance Invoice Schedule", "description" : "**Caution**\nThis API will return an error when [multi-frequency billing](/docs/api/subscriptions#subscription-billing-frequencies) is enabled.\n\nModifies the [advance invoicing schedule](/docs/api/advance_invoice_schedules) for a subscription.\n", "operationId" : "edit_advance_invoice_schedule", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "terms_to_charge" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of billing cycles in one interval.\n", "minimum" : 1, "example" : null }, "schedule_type" : { "type" : "string", "deprecated" : false, "description" : "The type of advance invoice or advance invoicing schedule.\n\\* specific_dates -\n\nCharge on [specific dates](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_date).\nFor each date, specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_terms_to_charge)\nto charge for. Up to 5 dates can be configured.\n\\* fixed_intervals -\n\nCharge at fixed intervals of time. Specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#terms_to_charge)\nthat constitute an interval and the number of [days before each interval](/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_days_before_renewal)\nthat the invoice should be generated. Also specify [when the schedule should end](/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_end_schedule_on)\n.\n", "enum" : [ "specific_dates", "fixed_intervals" ], "example" : null }, "fixed_interval_schedule" : { "type" : "object", "deprecated" : false, "description" : "Parameters for fixed_interval_schedule\n", "properties" : { "number_of_occurrences" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles\nof the subscription. This parameter is applicable only when fixed_interval_schedule[end_schedule_on]\n= after_number_of_intervals
Specifies when the schedule should end.
\n* after_number_of_intervals -Advance invoices are generated a specified number of times
Advance invoices are generated for as long as the subscription is active.
\n* specific_date -End the advance invoicing schedule on a specific date\n.
The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when fixed_interval_schedule[end_schedule_on]\n= specific_date\n.
The number of billing cycles to charge for, on the date specified. Applicable only when schedule_type\nis specific_dates.
The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when schedule_type\nis specific_dates\n.
Resource object representing advance_invoice_schedule
", "items" : { "$ref" : "#/components/schemas/AdvanceInvoiceSchedule", "description" : "Resource object representing advance_invoice_schedule" }, "example" : null } }, "required" : [ "advance_invoice_schedules" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/discounts" : { "get" : { "summary" : "List discounts for a subscription", "description" : "Retrieves a list of discount\nresources currently attached\nto a specific subscription. The list is sorted in descending order based on the created_at\ntimestamp.
Note\nThis endpoint does not return coupon or coupon_code resources.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Use this API to pause an active or non-renewing subscription. When a subscription is paused, it does not renew, and Chargebee does not generate renewal invoices for it. This allows you to temporarily suspend a customer's service without canceling the subscription.
active or non_renewing state can be paused.Subscription
If the pause_option parameter is set to immediately, the subscription's status changes to paused. The next_billing_at, pause_date, and resume_date values are updated based on the input parameters.
Unbilled Charges
If the subscription has unbilled charges and is paused immediately, you can choose to leave the charges unbilled or invoice them. If invoiced, Chargebee attempts payment collection based on the customer's auto-collection settings. If payment fails or auto-collection is not enabled, the invoice is marked as unpaid.
Use the unbilled_charges_handling parameter to set your preference.
Dunning
If the subscription has unpaid invoices in dunning and is paused immediately, you can choose to either stop or continue the dunning process.
Use the invoice_dunning_handling parameter to set your preference.
Scheduled Ramps
Any future subscription ramps (such as price or quantity changes) effective on or after the pause date are automatically deleted.
Advanced Invoices
If the subscription has an advance invoice, Chargebee creates an adjustment credit note if the invoice is unpaid or in a payment-due state. If the invoice is already paid, a refundable credit note is created.
Before calling this API, perform the following checks:
status is active or non_renewing. If it isn't, the API returns an invalid_state_for_pause error.has_scheduled_changes attribute. If true, either remove the scheduled changes before calling the API or avoid the operation. Otherwise, the API returns an operation_failed error.contract_term attribute is not present, or if it is present, that contract_term.status is not active. Otherwise, the API returns an invalid_request error.non_renewing state and you want to set the pause date to a future date, the pause date must be earlier than the cancellation date. If you specify a resume date, it must also be earlier than the cancellation date.List of options to pause the subscription.
\n* billing_cycles -Pause at the end of the current term, and resume automatically after the set number of billing cycles (in skip_billing_cycles) have been skipped
Pause immediately
\n* end_of_term -Pause at the end of current term
\n* specific_date -Pause on a specific date
", "enum" : [ "immediately", "end_of_term", "specific_date", "billing_cycles" ], "example" : null }, "pause_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Date on which the subscription will be paused. Applicable when specific_date option is chosen in the pause_option field.\nFor non-renewing subscriptions, pause_date should be before the cancellation date.
Applicable when unbilled charges are present for the subscription and pause_option is set as immediately. Note: On the invoice raised, an automatic charge is attempted on the payment method available, if customer's auto-collection property is set to on.
Invoice charges\nIf invoice is chosen, an automatic charge is attempted on the payment method available if the customer has enabled auto-collection. If a payment collection fails or when auto-collection is not enabled, the invoice is closed as unpaid.
Retain as unbilled\nIf no_action is chosen, charges are added to the resumption invoice.
Handles dunning for invoices already in the dunning cycle when a subscription is paused. Applicable when pause_option is set as immediately.\nIf invoice is in the dunning cycle, invoice_dunning_handing allows you to stop or continue dunning.
Continue dunning
\n* stop -Stop dunning
", "enum" : [ "continue", "stop" ], "example" : null }, "skip_billing_cycles" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of subscription billing cycles that will be skipped. The subscription resumes after the set number of billing cycles have been skipped. This is applicable only when the value of of pause_option\nis billing_cycles\n.
For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.\nFor non-renewing subscriptions,resume_date should be before the cancellation date.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null }, "credit_notes" : { "type" : "array", "description" : "Resource object representing credit_note
", "items" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/scheduled_changes" : { "get" : { "summary" : "Scheduled_changes a subscription_scheduled_change", "operationId" : "scheduled_changes_a_subscription_scheduled_change", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "subscription_scheduled_change" : { "$ref" : "#/components/schemas/SubscriptionScheduledChange", "description" : "Resource object representing subscription_scheduled_change" } }, "required" : [ "subscription_scheduled_change" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/update_scheduled_changes" : { "post" : { "summary" : "Update_scheduled_changes a subscription_scheduled_change", "operationId" : "update_scheduled_changes_a_subscription_scheduled_change", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "cancel_reason_code" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "action_type" : { "type" : "string", "deprecated" : false, "enum" : [ "cancel", "pause", "reactivate" ], "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "subscription_scheduled_change" : { "$ref" : "#/components/schemas/SubscriptionScheduledChange", "description" : "Resource object representing subscription_scheduled_change" } }, "required" : [ "subscription_scheduled_change" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/delete" : { "post" : { "summary" : "Delete a customer", "description" : "Deletes a specified customer.
This operation schedules the customer resource for deletion, and it is permanently deleted after a few minutes.
If you wish to retain the customer data but stop further subscription renewals, consider canceling or pausing the subscriptions instead.
Subscriptions
Invoices
Credit notes
Payment sources
The payment sources linked to the customer are deleted and also removed from the payment gateway. To retain payment gateway records, pass delete_payment_method = false.
Reports
Before deleting a customer, ensure the following:
invoice.linked_payments[]).transaction.customer_id) is this customer.credit_note.allocations.invoice_id).invoice.customer_id) is this customer.credit_note.applied_credits.cn_id).credit_note.customer_id) is this customer.Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/relationships" : { "post" : { "summary" : "Link a customer to an account hierarchy", "description" : "Creates a hierarchical relationship between two customers. The path parameter customer_id identifies the child in this relationship, and parent_id identifies the parent.
Note
For the use_default_hierarchy_settings, parent_account_access, and child_account_access parameters in this operation, the term "parent" usually refers to payment_owner_id. If payment_owner_id is the same as customer_id, then "parent" refers to parent_id.
customer_id and parent_id must belong to the same business entity.Customer
customer resource:\n\nInvoices
customer_id after you link the customer, Chargebee sets invoice.customer_id to invoice_owner_id.Transactions
customer_id, if auto_collection is on for invoice_owner_id, Chargebee uses the payment_source of the payment_owner_id to pay the invoices and creates transactions for the payment under payment_owner_id.RevenueStory
ID of the customer intended to be set as the immediate parent of the customer identified by customer_id\n.
The id of the customer responsible for paying the invoices for the customer identified by customer_id.
Constraints
invoice_owner_id is the same as the customer_id, then the payment_owner_id can be the customer_id or an ancestor of the customer_id.invoice_owner_id is not the same as the customer_id, then the payment_owner_id must be the invoice_owner_id.The id of the customer who receives the invoice for charges incurred by the customer identified by customer_id.
Constraint
customer_id or one of its ancestors.Decides if Chargebee should apply settings from the Chargebee Billing UI or from this API request.
\ntrue: Chargebee uses settings configured in the Chargebee Billing UI.false: Settings provided in the parent_account_access and child_account_access parameters are applied.If set to true\n, the parent receives email notifications for the child's subscriptions.
If set to true\n, the parent receives email notifications for payment-related activities on the child's invoices.
If set to true\n, the parent receives email notifications for the child's invoices.
If set to true\n, the child account receives email notifications for its subscriptions.
If set to true\n, the child account receives email notifications for payment-related activities for its invoices.
If set to true\n, the child account receives email notifications for its invoices.
Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/delete_relationship" : { "post" : { "summary" : "Unlink a customer from its parent account", "description" : "When a customer belongs to an [account hierarchy](https://www.chargebee.com/docs/2.0/account-hierarchy.html)\n, this operation detaches the customer from its parent. The hierarchy, if any, beneath the customer remains unchanged.\n", "operationId" : "delink_a_customer", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "customer-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/customer-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/delete_contact" : { "post" : { "summary" : "Delete contacts for a customer", "description" : "Deletes a particular contact for a customer. You can delete a contact by giving the Contact ID as the input parameter.\n", "operationId" : "delete_contacts_for_a_customer", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "customer-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/customer-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "contact" : { "type" : "object", "deprecated" : false, "description" : "Parameters for contact\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Unique reference ID provided for the contact.\n", "maxLength" : 150, "example" : null } }, "required" : [ "id" ], "example" : null } }, "example" : null }, "encoding" : { "contact" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/assign_payment_role" : { "post" : { "summary" : "Assign payment role", "description" : "Assign or unassign the primary or backup payment role for a payment source.
You can also assign a payment source as primary when you create it using APIs such as:
Chargebee uses the following precedence to determine which payment source to use when it collects payments for a subscription:
deleted.status of the payment source. Check the status of the payment source before you assign it to the primary or backup role.The roles that you set using this API apply to all payments collected for the customer, except for subscriptions that have a payment source attached to them. Chargebee continues to collect such payments using the payment source attached to the subscription.
backup payment source to primary or none.primary payment source to either backup or none.Before you call this API, ensure the following:
payment_source.customer_id matches the id of the customer.payment_source_id isn't the same as the customer.primary_payment_source_id.status of the payment source, check the payment_source.status to ensure it isn't expired, invalid, or pending_verification.Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/move" : { "post" : { "summary" : "Move a customer", "description" : "This API copies a customer object from one site to another. The destination site (the site to which the customer is copied) is specified by the path parameter {site}; whereas, the source site (the site from which the customer is copied) is specified by the query parameter from_site.
Prerequisites
preferred_currency_code must be enabled in the destination site.Resource object representing resource_migration
" } }, "required" : [ "resource_migration" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/hierarchy" : { "get" : { "summary" : "Get account hierarchy for a customer", "description" : "Retrieves the full or partial [account hierarchy](/docs/api/hierarchies)\nfor a customer.\n", "operationId" : "get_hierarchy", "parameters" : [ { "name" : "hierarchy_operation_type", "in" : "query", "description" : "Specifies which part of the account hierarchy to retrieve for the customer identified by {customer_id}\n.
Retrieve all nodes in the account hierarchy.
\n* subordinates -Retrieve all nodes in the account hierarchy that start from the specified customer (identified by {customer_id}\n) and include its subordinates. In other words, get nodes in the account hierarchy tree where the root node is the specified customer.
List all the nodes of the hierarchy formed by its subordinates with unbilled charges whose payment owner is the customer.
\n* path_to_root -Retrieve nodes from the specified customer (identified by {customer_id}\n) to the root of its account hierarchy.
Resource object representing hierarchy
", "items" : { "$ref" : "#/components/schemas/Hierarchy", "description" : "Resource object representing hierarchy" }, "example" : null } }, "required" : [ "hierarchies" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/update_payment_method" : { "post" : { "summary" : "Update payment method for a customer", "description" : "Payment Sources\ncomes with additional options and improvements to the Card APIs\n. For this operation, use the Create using temporary token\nAPI or Create using permanent token\nAPI under Payment Sources to update payment method for the customer.
Updates payment method details for a customer.
Note:\nIf you wish to pass the card number, CVV, or the single-use card tokens provided by gateways like Stripe, then use the Update card for a customer\nAPI under Cards resource. This API is not supported for Chargebee Test Gateway, it is provided to help you understand the billing workflow in Chargebee.
PayPal Express Checkout\nYou can use this API if you are directly integrating PayPal Express Checkout in your website instead of using Chargebee's hosted pages. When your customer updates his payment method using PayPal Express Checkout, you will be provided with the Billing Agreement ID by PayPal. You can update the payment method for that customer in Chargebee by passing type as paypal_express_checkout and reference_id with the Billing Agreement ID.
Login and Pay with Amazon\nYou can use this API if you are directly integrating Login and Pay with Amazon in your website instead of using Chargebee's hosted pages. When your customer updates Amazon as a payment method, you will be provided with the Billing Agreement ID by Amazon. You can update the payment method for that customer in Chargebee by passing type as amazon_payments and reference_id with the Billing Agreement ID.
Card Payments\nWhen the card details of your customer are stored in the vault of gateways such as Stripe or Braintree, you can use this API to update the reference id provided by them in Chargebee. To use this API, pass
type as card.gateway with the gateway associated with the card. If the gateway is not specified, the default gateway will be used.reference_id with the identifier provided by the gateway/Spreedly to reference that specific card.Reference id format for Card Payments\nThe format of reference_id will differ based on where the card is stored.
Stripe: In case of Stripe, the reference_id consists of combination of Stripe Customer ID and Stripe Card ID separated by forward slash (e.g. cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G). If you are passing Stripe Customer ID alone, then Chargebee will store the card marked as active for that customer in Stripe.
Braintree: In case of Braintree, the reference_id consists of combination of Braintree Customer ID and Braintree Payment Method Token separated by forward slash\n(e.g. cus_63MnDn0t6kfDW7/card_6WjCF20vT9WN1G ). If you are passing Braintree Customer ID alone, then Chargebee will store the card marked as default for that customer in Braintree.
Spreedly Card vault: If the card details are stored in Spreedly vault, then you need to provide the Spreedly token as reference_id.
Direct Debit Payments\nWhen the bank account details of your customer are stored in the gateway vault, you can use this API to update the reference id provided by them in Chargebee. To use this API, pass
type as direct_debit.gateway with the gateway where the bank account details are stored (e.g. authorize_net). If the gateway is not specified, the gateway supporting the direct debit will be used.reference_id with the identifier provided by the gateway to reference the customer's bank account details.tmp_token with the single use token provided by the gateway ( Should be passed only if reference_id is not passed ).Reference id format for Direct Debit Payments\nThe format of reference_id will differ based on where the bank account is stored.
Stripe: In case of Stripe, the reference_id consists of combination of Stripe Customer ID and Stripe Bank Account ID separated by forward slash\n(e.g. cus_8suoHaLQH4G5AW/ba_18b8z2KmcbENlhgU03RznRYW). If you are passing Stripe Customer ID alone, then Chargebee will store the first bank account details present in payment profile list of that customer in Stripe.
Authorize.Net: The reference_id consists of combination of Authorize.Net's Customer Profile ID and Payment Profile ID separated by forward slash (e.g. 2384383/34834382). If you are passing Authorize.Net's Customer Profile ID alone, then Chargebee will store the first bank account details present in payment profile list of that customer in Authorize.Net.
GoCardless: The reference_id is the GoCardless Customer Mandate ID (e.g. MD0077Z99TTQXK).
Note: While using this API to update payment method details, Card Verification will not happen even if it is enabled for that particular gateway.
ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nIf you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, then XI\n(the code for United Kingdom - Northern Ireland\n) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}" : { "get" : { "summary" : "Retrieve a customer", "description" : "Retrieves the details of the desired customer. You can use the unique identifier for a particular customer to retrieve the desired details.\n", "operationId" : "retrieve_a_customer", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "customer-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/customer-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a customer", "description" : "Updates the details of the specified customer.
Use this API to modify customer information, including standard attributes and any configured custom attributes.
Invoices
auto_collection parameter to understand the impact on invoices.taxability parameter to understand how taxes on invoices are impacted.CRM integrations
When you update customer details in Chargebee using this API, the corresponding records are synced with integrated CRM systems, such as HubSpot or Salesforce, depending on your integration configuration.
The number of days from invoice.date until payment for the invoice is due.
Specifies whether taxes are applicable to invoices generated for this customer.
\n* taxable -Taxes are calculated for this customer based on the site's tax configuration.\nIn some regions, shipping_address is required for tax computation.\nIf a shipping address is not provided, the billing_address is used. If neither address is available, no tax is applied.
\n* exempt -The customer is exempt from tax.
\nentity_code or exempt_number attributes with AvaTax for Sales, or the exemption_details attribute with AvaTax for Communications. Avalara may still apply tax depending on the values of entity_code, exempt_number, or exemption_details, and the jurisdiction (state, region, or province) of the taxable address.Indicates whether invoices raised on the same day for the customer are consolidated. When provided, this overrides the default configuration at the site-level. This parameter can be provided only when Consolidated Invoicing is enabled.
Note:
Any invoices raised when a subscription activates from in_trial or future status, are not consolidated by default. Contact Support to enable consolidation for such invoices.
.
", "example" : null }, "tax_providers_fields" : { "type" : "object", "deprecated" : false, "description" : "Parameters for tax_providers_fields\n", "properties" : { "provider_name" : { "type" : "array", "description" : "Name of the tax provider.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "example" : null }, "field_id" : { "type" : "array", "description" : "Field id of the attribute which tax vendor has provided while getting onboarded with Chargebee.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "example" : null }, "field_value" : { "type" : "array", "description" : "The value of the related tax field\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "example" : null } }, "example" : null } }, "example" : null }, "encoding" : { "tax_providers_fields" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/hierarchy_detail" : { "get" : { "summary" : "Get paginated account hierarchy for a customer", "description" : "Retrieves the [account hierarchy tree](/docs/api/hierarchies)\nfor the customer.\n", "operationId" : "list_hierarchy_details", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "customer-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/customer-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Used for pagination. Set this to the next_offset\nvalue from the previous API response to fetch the next page.
billing_month, together with billing_date, specify, for this customer, the day of the year when the renewals of all the year-based subscriptions take place.
For example, the renewals happen on 15th July when billing_month is 7 and billing_date is 15.
Note\nApplicable when Calendar Billing (with customer-specific billing date support) is enabled and billing_date_mode is manually_set.
Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers" : { "get" : { "summary" : "List customers", "description" : "Retrieves a list of customers added to your Chargebee site. The list contains the necessary customer details such as First Name, Last Name and the Customer ID.\n", "operationId" : "list_customers", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.optional, timestamp(UTC) in seconds filter
\nTo filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[after] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "offline_payment_method", "in" : "query", "description" : "optional, enumerated string filter\n\nThe preferred offline payment method for the customer. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*offline_payment_method\\[is\\] = \"cash\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "cash", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\n", "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\n", "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\n", "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ], "pattern" : "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\n", "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ], "pattern" : "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\]$", "example" : null } } } }, { "name" : "auto_close_invoices", "in" : "query", "description" : "optional, boolean filter\n\nOverride for this customer, the [site-level setting](https://www.chargebee.com/docs/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", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "true", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "channel", "in" : "query", "description" : "optional, enumerated string filter\n\nThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*channel\\[is\\] = \"APP STORE\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "APP STORE", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null } } } }, { "name" : "business_entity_id", "in" : "query", "description" : "optional, string filter\n\nThe unique ID of the [business entity](/docs/api/advanced-features)\nof this subscription. This is always the same as the\n[business entity](/docs/api/subscriptions/subscription-object#customer_id)\nof the customer.\n\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*business_entity_id\\[is_not\\] = \"business_entity_id\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null } } } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\ncreated_at, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"created_at\"*\n\nThis will sort the result based on the 'created_at' attribute in ascending(earliest first) order.\n", "required" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "asc" : { "type" : "string", "enum" : [ "created_at", "updated_at" ], "example" : null }, "desc" : { "type" : "string", "enum" : [ "created_at", "updated_at" ], "example" : null } }, "example" : null } }, { "name" : "relationship", "in" : "query", "description" : "Parameters for relationship\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "parent_id" : { "type" : "object", "deprecated" : false, "description" : "Immediate parent with whom we will link our new customer(child)\n", "example" : "future_billing", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } } }, "payment_owner_id" : { "type" : "object", "deprecated" : false, "description" : "Parent who is going to pay\n", "example" : "active1", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } } }, "invoice_owner_id" : { "type" : "object", "deprecated" : false, "description" : "Parent who is going to handle invoices\n", "example" : "future_billing", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } } } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card" } }, "required" : [ "customer" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Create a customer", "description" : "Creates a customer resource. Optionally, creates a payment source for the customer.
Creating payment source
Although this operation supports creation of a customer with a payment source, it is recommended to use one of the Payment Source APIs to capture payment source details instead of using this operation. This way, even if payment source creation fails due to errors at the payment gateway, the customer resource can still be created successfully.
billing_address object from the customer to set the values in the billing_address of the invoices generated for the customer.billing_address object does not include the first_name, last_name, or company fields, Chargebee automatically uses the values from customer.first_name, customer.last_name, and customer.company (if available) when generating invoices.payment_intent or payment_method parameter is passed, a payment_source resource of the appropriate type is created for the customer.bank_account parameter is passed, a payment_source resource of type direct_debit is created for the customer.card parameter is passed, a payment_source resource of type card is created for the customer.payment_intentUse the payment_intent parameter to create a payment source for the customer. Using payment intents is the recommended way to create a payment source in Chargebee for both Strong Customer Authentication (SCA) (i.e. 3D-Secure) and non-SCA flows.
payment_intent resource by calling the Create a payment intent API.payment_intent object to your frontend and use Chargebee.js to capture the payment source details from the customer. Use Payment Method Helpers to show payment method UIs and collect payment method details from the customer.payment_intent_updated event. Once the payment_intent.status is authorized, pass the payment_intent.id using the payment_intent[id] parameter in this API call.payment_methodIf you prefer to use the payment gateway's SDKs to capture the payment method details, you can then use the payment_method parameter in this API to pass the payment method token and other details.
payment_method[reference_id] or payment_method[tmp_token] parameter along with any additional parameters required by the payment gateway to create the payment source.bank_accountYou can pass raw bank account details via this API. Use the bank_account parameter to pass the bank account details.
cardIf you are PCI compliant, you can pass raw card details via this API. Use the card parameter to pass the card details.
Whether payments needs to be collected automatically for this customer.
\nConstraints
offline_payment_method cannot be passed when auto_collection is set to on.Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made.
\n* off -Automatic collection of charges will not be made. All payments must be recorded offline.
", "enum" : [ "on", "off" ], "example" : null }, "net_term_days" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days from invoice.date until payment for the invoice is due.
The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Determines whether the customer is e-invoiced. When set to true\nor not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (billing_address.country\n). When set to false\n, the customer is not e-invoiced even if e-invoicing is enabled for their country.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
Specifies if the customer is liable for tax.
\n* taxable -Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.
\n* exempt -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.Determines which region-specific language Chargebee uses to communicate with the customer. Use the language pack to customize the translations for each locale.
\nConstraints
Prerequisite
Default behavior
locale, or if you pass it but it is not added and activated in Chargebee, then the primary language for customers would be used.The preferred offline payment method for the customer.
\nConstraints
off when passing this parameter.Prerequisites
SEPA Credit
\n* cash -Cash
\n* no_preference -No Preference
\n* bank_transfer -Bank Transfer
\n* check -Check
\n* eu_automated_bank_transfer -EU Automated Bank Transfer
\n* jp_automated_bank_transfer -JP Automated Bank Transfer
\n* uk_automated_bank_transfer -UK Automated Bank Transfer
\n* custom -Custom
\n* boleto -Boleto
\n* mx_automated_bank_transfer -MX Automated Bank Transfer
\n* us_automated_bank_transfer -US Automated Bank Transfer
\n* ach_credit -ACH Credit
", "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ], "example" : null }, "auto_close_invoices" : { "type" : "boolean", "deprecated" : false, "description" : "Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing)\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices)\nwhich takes precedence.\n", "example" : null }, "consolidated_invoicing" : { "type" : "boolean", "deprecated" : false, "description" : "Indicates whether invoices raised on the same day for the customer are consolidated. When provided, this overrides the default configuration at the site-level. This parameter can be provided only when Consolidated Invoicing is enabled.
Note:
Any invoices raised when a subscription activates from in_trial or future status, are not consolidated by default. Contact Support to enable consolidation for such invoices.
.
", "example" : null }, "token_id" : { "type" : "string", "deprecated" : false, "description" : "The Chargebee payment token generated by Chargebee JS.
\nNote:\nThe payment token created via Chargebee JS uses the gateway selected through Smart Routing.\nExplicitly passing a gateway_id\nin this API call will not override the gateway associated with the token.
The gateway account in which these card details are stored.
\nRequired when
card parameter.The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe gateway account in which this payment source is stored.
\nRequired when
bank_account parameter.The billing address associated with the bank account. The value is a JSON object with the following keys and their values:- first_name:(string, max chars=150) The first name of the contact.
last_name:(string, max chars=150) The last name of the contact.company_name:(string, max chars=250) The company name for the address.line1:(string, max chars=180) The first line of the address.line2:(string, max chars=180) The second line of the address.country:(string) The name of the country for the address.country_code:(string, max chars=50) The two-letter, ISO 3166 alpha-2 country code for the address.state:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, and India.state_code:(string, max chars=50) The ISO 3166-2 state/province code without the country prefix. This is supported for USA, Canada, and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).city:(string, max chars=50) The city name for the address.postal_code:(string, max chars=20) The postal or ZIP code for the address.phone:(string, max chars=50) The contact phone number for the address.email:(string, max chars=70) The contact email address for the address.ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nIf you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, then XI\n(the code for United Kingdom - Northern Ireland\n) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceIdentifier for the payment_intent resource. If you provide this parameter, you do not need to pass other payment_intent parameters.
Prerequisites
payment_intent.status must be authorized.The payment method type.
\nDefault value
cardcard
\n* twint -Payments made via Twint
\n\n* dotpay -dotpay
\n* faster_payments -Faster Payments
\n\n* upi -upi
\n* kbc_payment_button -KBC Payment Button
\n* payme -Payments made via PayMe
\n\n* google_pay -google_pay
\n* paypal_express_checkout -paypal_express_checkout
\n* pix -Pix
\n\n* klarna_pay_now -Klarna Pay Now
\n\n* ideal -ideal
\n* boleto -boleto
\n* wechat_pay -Payments made via WeChat Pay.
\n\n* after_pay -Payments made via Afterpay
\n\n* grab_pay -Payments made via GrabPay
\n\n* direct_debit -direct_debit
\n* sepa_instant_transfer -Sepa Instant Transfer
\n\n* bancontact -bancontact
\n* kakao_pay -Payments made via Kakao Pay.
\n\n* swish -Payments made via Swish
\n\n* go_pay -Payments made via GoPay
\n\n* trustly -Trustly
\n* naver_pay -Payments made via Naver Pay.
\n\n* stablecoin -Payments made via Stablecoin.
\n\n* venmo -Venmo
\n\n* alipay -Payments made via Alipay.
\n\n* pay_to -PayTo
\n\n* pay_co -Payments made via PayCo
\n\n* cash_app_pay -Payments made via Cash App Pay.
\n\n* netbanking_emandates -netbanking_emandates
\n* payconiq_by_bancontact -Payments made via Payconiq by Bancontact.
\n\n* electronic_payment_standard -Electronic Payment Standard
\n* pay_by_bank -Pay By Bank
\n* apple_pay -apple_pay
\n* online_banking_poland -Online Banking Poland
\n\n* giropay -giropay
\n* sofort -sofort
\n* amazon_payments -Amazon Payments
\n* revolut_pay -Payments made via Revolut Pay.
\n", "enum" : [ "card", "ideal", "sofort", "bancontact", "google_pay", "dotpay", "giropay", "apple_pay", "upi", "netbanking_emandates", "paypal_express_checkout", "direct_debit", "boleto", "venmo", "amazon_payments", "pay_to", "faster_payments", "sepa_instant_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "wechat_pay", "alipay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna" ], "example" : null }, "reference_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.\n", "maxLength" : 65000, "example" : null }, "additional_information" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The unique id for the entity_identifier\nin Chargebee. When not provided, it is autogenerated.
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The value of the entity_identifier.\nThis identifies the customer entity on the Peppol network. For example: 10101010-STO-10\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The standard used for specifying the entity_identifier\nscheme.\nCurrently, only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/add_contact" : { "post" : { "summary" : "Add contacts to a customer", "description" : "\nEmail notifications
contact[send_billing_email] to true, the contact receives billing emails.contact[send_account_email] to true, the contact receives account emails.Check the customer's contacts[] array and ensure it contains fewer than 10 contacts before calling this API.
Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/contacts" : { "get" : { "summary" : "List of contacts for a customer", "description" : "This API retrieves all the contacts for a customer.\n", "operationId" : "list_of_contacts_for_a_customer", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "customer-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/customer-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/merge" : { "post" : { "summary" : "Merge customers", "description" : "This API moves a customer's payment methods, subscriptions, invoices, credit notes, transactions, unbilled charges, and orders to another customer. Events and email logs will not be moved. The API execution is asynchronous. \n**Note**\n\n* Moving virtual bank accounts from one customer to another is not supported in this API.\n* Merging customers from different [business entities](/docs/api/getting-started) is not permitted.\n", "operationId" : "merge_customers", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "from_customer_id" : { "type" : "string", "deprecated" : false, "description" : "From customer id.\n", "maxLength" : 50, "example" : null }, "to_customer_id" : { "type" : "string", "deprecated" : false, "description" : "To customer id.\n", "maxLength" : 50, "example" : null } }, "required" : [ "from_customer_id", "to_customer_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/collect_payment" : { "post" : { "summary" : "Collect payment for customer", "description" : "**Note:**\nThis operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\nand pass it as input parameter to this API.\n\nThis API can be used to collect the payments for customer's **payment_due** and **not_paid** invoices. You can either choose to collect the payment from an existing payment source or a new payment source. You can choose to either retain or discard the new payment source, which is being used for payment. If the amount collected exceeds the invoice amount, the surplus will be counted in as excess payments.\n", "operationId" : "collect_payment_for_customer", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "customer-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/customer-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Amount to be collected. If this parameter is not passed then the invoice(s) amount to collect will be collected.\n", "minimum" : 0, "example" : null }, "payment_source_id" : { "type" : "string", "deprecated" : false, "description" : "Payment source used for the payment.\n", "maxLength" : 40, "example" : null }, "token_id" : { "type" : "string", "deprecated" : false, "description" : "Token generated by Chargebee JS representing payment method details.\n", "maxLength" : 40, "example" : null }, "replace_primary_payment_source" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Indicates whether the primary payment source should be replaced with this payment source.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n", "example" : null }, "retain_payment_source" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Indicates whether the payment source should be retained for the customer.\n", "example" : null }, "payment_initiator" : { "type" : "string", "deprecated" : false, "description" : "The type of initiator to be used for the payment request triggered by this operation.\n\\* customer -\n\nPass this value to indicate that the request is initiated by the customer\n\\* merchant -\n\nPass this value to indicate that the request is initiated by the merchant\n", "enum" : [ "customer", "merchant" ], "example" : null }, "payment_method" : { "type" : "object", "deprecated" : false, "description" : "Parameters for payment_method\n", "properties" : { "type" : { "type" : "string", "deprecated" : false, "description" : "The type of payment method. For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\nAPI under Customer resource.\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* go_pay -\n\nPayments made via GoPay\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* 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\\* bancontact -\n\nPayments made via Bancontact Card.\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* upi -\n\nUPI Payments.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* card -\n\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\\* pay_to -\n\nPayments made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\\* trustly -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n", "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "apple_pay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna" ], "example" : null }, "gateway_account_id" : { "type" : "string", "deprecated" : false, "description" : "The gateway account in which this payment source is stored.\n", "maxLength" : 50, "example" : null }, "reference_id" : { "type" : "string", "deprecated" : false, "description" : "The reference id. In the case of Amazon and PayPal this will be the *billing agreement id* .\nFor GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource. **Note:**\nThis is not the one-time temporary token provided by gateways like Stripe.\n\nFor more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\nAPI under Customer resource.\n", "maxLength" : 200, "example" : null }, "tmp_token" : { "type" : "string", "deprecated" : false, "description" : "Single-use token created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet or card details. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.Net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.\n", "maxLength" : 65000, "example" : null }, "additional_information" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's devicecheckout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing customer
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "customer", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/record_excess_payment" : { "post" : { "summary" : "Record an excess payment for a customer", "description" : "Records an offline payment for a customer and adds it to the customer's excess payments balance.
Invoices
subscription.billing_override.The payment method of this transaction
\n* cash -Cash
\n* grab_pay -Payments made via GrabPay
\n\n* kakao_pay -Payments made via Kakao Pay.
\n\n* swish -Payments made via Swish
\n\n* alipay -Payments made via Alipay.
\n\n* sofort -Sofort
\n* direct_debit -Direct Debit
\n* electronic_payment_standard -Electronic Payment Standard
\n* netbanking_emandates -netbanking_emandates
\n* klarna_pay_now -Klarna Pay Now
\n\n* naver_pay -Payments made via Naver Pay.
\n\n* twint -Payments made via Twint
\n\n* payconiq_by_bancontact -Payments made via Payconiq by Bancontact.
\n\n* pay_by_bank -Pay By Bank
\n* go_pay -Payments made via GoPay
\n\n* kbc_payment_button -KBC Payment Button
\n* paypal_express_checkout -Paypal Express Checkout
\n* automated_bank_transfer -Automated Bank Transfer
\n\n* venmo -Venmo
\n\n* bancontact -Bancontact
\n* after_pay -Payments made via Afterpay
\n\n* custom -Custom payment method.
\nPrerequisite
IDEAL
\n* check -Check
\n* upi -upi
\n* sepa_instant_transfer -Sepa Instant Transfer
\n\n* sepa_credit -SEPA Credit
\n* ach_credit -ACH Credit
\n* faster_payments -Faster Payments
\n\n* trustly -Trustly
\n* bank_transfer -Bank Transfer
\n* chargeback -Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.
Unionpay
\n* apple_pay -Apple Pay
\n* dotpay -Dotpay
\n* amazon_payments -Amazon Payments
\n* wechat_pay -Payments made via WeChat Pay.
\n\n* cash_app_pay -Payments made via Cash App Pay.
\n\n* google_pay -Google Pay
\n* payme -Payments made via PayMe
\n\n* pay_co -Payments made via PayCo
\n\n* card -Card
\n* other -Payment Methods other than the above types
\n* boleto -boleto
\n* giropay -giropay
\n* pay_to -PayTo
\n\n* stablecoin -Payments made via Stablecoin.
\n\n* revolut_pay -Payments made via Revolut Pay.
\n\n* pix -Pix
\n", "enum" : [ "cash", "check", "bank_transfer", "other", "custom" ], "example" : null }, "reference_number" : { "type" : "string", "deprecated" : false, "description" : "The reference number for this transaction. e.g check number in case of 'check' payments.\n", "maxLength" : 100, "example" : null }, "custom_payment_method_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the custom payment method of this transaction.
\nPrerequisite
transaction[payment_method] is custom.Resource object representing customer
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "customer", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/update_contact" : { "post" : { "summary" : "Update contacts for a customer", "description" : "Updates the details of a contact for a customer. You can give the field data to be updated as input parameters along with the Contact ID to update it.\n", "operationId" : "update_contacts_for_a_customer", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "customer-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/customer-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "contact" : { "type" : "object", "deprecated" : false, "description" : "Parameters for contact\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Unique reference ID provided for the contact.\n", "maxLength" : 150, "example" : null }, "first_name" : { "type" : "string", "deprecated" : false, "description" : "First name of the contact.\n", "maxLength" : 150, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "Last name of the contact.\n", "maxLength" : 150, "example" : null }, "email" : { "type" : "string", "format" : "email", "deprecated" : false, "description" : "Email of the contact.\n", "maxLength" : 70, "example" : null }, "phone" : { "type" : "string", "deprecated" : false, "description" : "Phone number of the contact.\n", "maxLength" : 50, "example" : null }, "label" : { "type" : "string", "deprecated" : false, "description" : "Label/Tag provided for contact.\n", "maxLength" : 50, "example" : null }, "enabled" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Contact enabled / disabled\n", "example" : null }, "send_billing_email" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Whether Billing Emails option is enabled for the contact.\n", "example" : null }, "send_account_email" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Whether Account Emails option is enabled for the contact.\n", "example" : null } }, "required" : [ "id" ], "example" : null } }, "example" : null }, "encoding" : { "contact" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/update_hierarchy_settings" : { "post" : { "summary" : "Update account hierarchy access settings for a customer", "description" : "When the customer is part of an account hierarchy, this operation updates the access privileges that both the customer and its parent have to the customer's data.
Terminology\nThe term "parent" usually refers to the customer with the ID payment_owner_id. However, if the payment_owner_id is the same as the child's ID (given by the path parameter), the "parent" is identified by parent_id.
Tip\nYou cannot use this endpoint to change the parent_id, invoice_owner_id or payment_owner_id for the customer. To change them, unlink the customer and then call Link a customer with the updated values.
Decides if Chargebee should apply settings from the Chargebee Billing UI or from this API request.
\ntrue: Chargebee removes existing settings stored in the parent_account_access and child_account_access attributes of the customer. The settings configured in the Chargebee Billing UI apply for the customer.false: Chargebee replaces existing settings stored in the parent_account_access and child_account_access parameters with those passed in this API call. If any of those parameters are not passed, they remain unchanged for the customer.If true\n, the parent account will receive subscription-related emails sent to the child account.
If true\n, the parent account will receive payment-related emails sent to the child account.
If true\n, the parent account will receive invoice-related emails sent to the child account.
If true\n, the child account receives email notifications for its subscriptions.
If true\n, the child account receives email notifications for payment-related activities for its invoices.
If true\n, the child account receives email notifications for its invoices.
Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/update_billing_info" : { "post" : { "summary" : "Update billing info for a customer", "description" : "Updates a customer's billing information, including billing address and tax-related details such as VAT number.
Note
See Related APIs for other customer attributes that can be updated.
In some cases, passing the following parameters can cause the request to fail: vat_number, business_customer_without_vat_number, tax_providers_fields, and registered_for_gst. See Implementation Notes for more details.
Customer
For certain parameters, if you do not include a parameter in the request, Chargebee removes the corresponding attribute from the customer object. To retain an existing attribute, you must explicitly include its parameter in your request.
billing_address.first_namebilling_address.last_namebilling_address.phonebilling_address.emailbilling_address.line1billing_address.line2billing_address.line3billing_address.citybilling_address.statebilling_address.countrybilling_address.zipvat_numbervat_number_prefixbusiness_customer_without_vat_numberregistered_for_gstAssume the customer object has these attributes set:
Current attributes:
billing_address.first_namebilling_address.last_namebilling_address.phonebilling_address.emailvat_numberYou make an API call with only the following parameters:
Request parameters:
billing_address.first_namebilling_address.last_namebilling_address.phoneResult: The billing_address.email and vat_number attributes are removed from the customer object because they weren't included in the request. To preserve these attributes, include them in the request.
Invoices
billing_address object from the customer to set the values in the billing_address of the invoices generated for the customer.billing_address object does not include the first_name, last_name, or company fields, Chargebee automatically uses the values from customer.first_name, customer.last_name, and customer.company (if available) when generating invoices.vat_number and business_customer_without_vat_number = true are not passed together in the same request.tax_providers_fields is not passed if Indian GST is not configured for your site.registered_for_gst = true is not passed if Australian GST is not configured for your site.Prevent tax provider errors due to missing billing information
After integrating tax providers, you might encounter unintended tax calculation failures during renewals. The error message typically states:
\nUnable to calculate the tax rate as the shipping/billing address is either invalid or incomplete. Please verify and try again.
\n
This error can occur even if the is_taxable value of item prices is changed from true to false before subscription renewal and reactivation.
Use this operation to update the billing address attributes to ensure they are accurate and complete.
Error: 400: "Operation failed as the country entered in the billing address by the customer cannot be verified against IP address or card BIN number."
This error occurs when location validation is enabled in the tax settings and there's a mismatch between the customer's billing country and their IP address or the card issuing country.
Choose one of the following solutions:
Option A: Fix IP address mismatch
Use the Update a card payment source API and include the correct IP address in the request header.
Option B: Fix BIN mismatch
Ask the customer to update their payment method with one whose BIN matches their country. You can do this using the Request Payment Method option or the Self-Serve Portal.
Option C: Disable location validation
The VAT/tax registration number for the customer.\nFor customers with billing_address as XI (United Kingdom - Northern Ireland), the first two characters of the full VAT number can be overridden by setting vat_number_prefix.
Warning
business_customer_without_vat_number = true, the request will fail.An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address as XI (United Kingdom - Northern Ireland).
Warning\nIf you don't pass this parameter, the value will be deleted from the customer object.
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
Confirms that a customer is registered under GST. If set to true then the Reverse Charge Mechanism is applicable. This field is applicable only when Australian GST is configured for your site.
Warning
true and Australian GST is not configured for your site, the request will fail.Confirms that a customer is a valid business without an EU/UK VAT number.
\nWarning
true and also pass vat_number, the request will fail.Determines whether the customer is e-invoiced. When set to true\nor not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (billing_address.country\n). When set to false\n, the customer is not e-invoiced even if e-invoicing is enabled for their country.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India.\nFor example:
\nstate_code as AZ (not US-AZ).TN (not IN-TN).BC (not CA-BC).The state/province name.
\nWarning\nIf you don't pass this parameter, the value will be deleted from the customer object.
Note\nIf you don't pass this parameter, the value will be set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
\nWarning\nIf you don't pass this parameter, the value will be deleted from the customer object.
Brexit\nIf you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
E-Invoicing\nIf country is provided as different from the existing value and if entity_identifier_scheme, entity_identifier_standard, and entity_identifier already exist and are not provided for this operation, they're cleared.
The unique id for the entity_identifier[i] in Chargebee. This is required when entity_identifier[operation][i] is update or delete.
The Peppol BIS scheme associated with the vat_number of the customer. This helps identify the specific type of customer entity. For example, DE:VAT is used for a German business entity while DE:LWID45 is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country. See list of possible values.
Tip\nIf there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See entity_identifiers[] description.
The value of the entity_identifier.\nThis identifies the customer entity on the Peppol network. For example: 10101010-STO-10\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The operation to be performed for the entity_identifier.
Updates an existing entity_identifier for the customer. entity_identifier[id] must be provided in this case.
Deletes an existing entity_identifier for the customer. entity_identifier[id] must be provided in this case.
Creates a new entity_identifier for the customer.
The standard used for specifying the entity_identifier\nscheme.\nCurrently, only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/tokens/create_using_temp_token" : { "post" : { "summary" : "Create using vault temp token", "description" : "Generate a token using the one time token created by payment gateways for any specific payment method.\n", "operationId" : "create_using_vault_temp_token", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "gateway_account_id" : { "type" : "string", "deprecated" : false, "description" : "The gateway account to which the token is associated.\n", "maxLength" : 50, "example" : null }, "payment_method_type" : { "type" : "string", "deprecated" : false, "description" : "Type of payment method of the token.\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* pay_co -\n\nPayments made via PayCo\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* bancontact -\n\nPayments made via Bancontact Card.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* trustly -\n\nTrustly\n\\* after_pay -\n\nPayments made via Afterpay\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* giropay -\n\nPayments made via giropay.\n\\* upi -\n\nUPI Payments.\n\\* sofort -\n\nPayments made via Sofort.\n\\* pay_by_bank -\n\nPay By Bank\n\\* go_pay -\n\nPayments made via GoPay\n\\* swish -\n\nPayments made via Swish\n\\* direct_debit -\n\nRepresents bank account for which the direct debit or ACH agreement/mandate is created.\n\\* twint -\n\nPayments made via Twint\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* payme -\n\nPayments made via PayMe\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* kbc_payment_button -\n\nKBC Payment Button\n", "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "apple_pay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna" ], "example" : null }, "id_at_vault" : { "type" : "string", "deprecated" : false, "description" : "Single-use token created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.\n", "maxLength" : 65000, "example" : null }, "gw_obj_type" : { "type" : "string", "deprecated" : false, "description" : "Represents what type of object at gateway eg. \"token\" in case Stripe token and \"source\" in case of Stripe Source.\n", "maxLength" : 255, "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "Used to derieve Bank Account Scheme by default will take site default currency.\n", "maxLength" : 3, "example" : null }, "additional_information" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device\n.The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Resource object representing token
" } }, "required" : [ "token" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/tokens/create_for_card" : { "post" : { "summary" : "Create a card payment method token", "description" : "Generate a token that holds card related information.\n", "operationId" : "create_a_card_payment_method_token", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "card" : { "type" : "object", "deprecated" : false, "description" : "Parameters for card\n", "properties" : { "gateway_account_id" : { "type" : "string", "deprecated" : false, "description" : "The gateway account in which this payment source is stored.\n", "maxLength" : 50, "example" : null }, "first_name" : { "type" : "string", "deprecated" : false, "description" : "Cardholder's first name\n", "maxLength" : 50, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "Cardholder's last name\n", "maxLength" : 50, "example" : null }, "number" : { "type" : "string", "deprecated" : false, "description" : "The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)\n, you can specify the Braintree encrypted card number here.\n", "maxLength" : 1500, "example" : null }, "expiry_month" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Card expiry month.\n", "maximum" : 12, "minimum" : 1, "example" : null }, "expiry_year" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Card expiry year.\n", "example" : null }, "cvv" : { "type" : "string", "deprecated" : false, "description" : "The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)\n, you can specify the Braintree encrypted CVV here.\n", "maxLength" : 520, "example" : null }, "preferred_scheme" : { "type" : "string", "deprecated" : false, "description" : "The customer's preferred card scheme for co-branded cards. \n**Note**:\nCurrently, this parameter is only supported for Stripe.\n\\* cartes_bancaires -\n\nA Cartes Bancaires card scheme.\n\\* mastercard -\n\nA MasterCard scheme.\n\\* mada -\n\nA Mada card scheme.\n\\* visa -\n\nA Visa card scheme.\n", "enum" : [ "cartes_bancaires", "mastercard", "visa" ], "example" : null }, "billing_addr1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1, as available in card billing address.\n", "maxLength" : 150, "example" : null }, "billing_addr2" : { "type" : "string", "deprecated" : false, "description" : "Address line 2, as available in card billing address.\n", "maxLength" : 150, "example" : null }, "billing_city" : { "type" : "string", "deprecated" : false, "description" : "City, as available in card billing address.\n", "maxLength" : 50, "example" : null }, "billing_state_code" : { "type" : "string", "deprecated" : false, "description" : "The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing token
" } }, "required" : [ "token" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/tokens/{cb-token-id}" : { "get" : { "summary" : "Retrieve a token", "description" : "Retrieve a token using token ID.\n", "operationId" : "retrieve_a_token", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "cb-token-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/cb-token-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "token" : { "$ref" : "#/components/schemas/Token", "description" : "Resource object representing token
" } }, "required" : [ "token" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_using_permanent_token" : { "post" : { "summary" : "Create using permanent token", "description" : "Creates a payment source for a customer using a permanent token obtained from the payment gateway.
Use this API to add a payment method that has already been vaulted in your gateway account. The permanent token enables Chargebee to securely link the payment method to the customer. This enables payment collection for future charges (both recurring and one-time) without requiring the customer to re-enter their payment details.
gateway_account_id parameter if:\nPass the replace_primary_payment_source parameter as true to update the customer's primary_payment_source_id. Otherwise, the existing primary payment source will remain unchanged.
The reference id. In the case of Amazon and PayPal, this will be the billing agreement ID. For GoCardless direct debit this will be mandate_id. In the case of a card, this will be the identifier provided by the gateway or card vault for the specific payment method resource.
Note:
This is not the one-time temporary token provided by gateways like Stripe.
\nreference_id is an alternative for payment_method_token, customer_profile_token, network_transaction_id, or mandate_id.
payment_method_token, customer_profile_token, network_transaction_id, or mandate_id cannot be used with reference_id.
reference_id is a combination of multiple tokens available at the gateway. Learn more about the combination of each gateway from this document.
An identifier provided by the gateway or card vault for the specific payment method resource.
\nNote:\npayment_method_token is an alternative for reference_id and cannot be used with reference_id.
A unique identifier associated with a customer`s profile within a payment gateway.
\nNote:\ncustomer_profile_token is an alternative for reference_id and cannot be used with reference_id.
An identifier of the payment or authorization transaction at the gateway initiated using this payment method.
\nNote:\nnetwork_transaction_id is an alternative for reference_id and cannot be used with reference_id.
An identifier of mandates which is an authorization given by the payer (usually a customer or account holder) to allow a third party such as a merchant or service provider to initiate payments from their account.
\nNote:\nmandate_id is an alternative for reference_id and cannot be used with reference_id.
By default, the value is false and payment method details will be retrieved from the selected payment gateway using reference_id or payment_method_token / customer_profile_token / network_transaction_id / mandate_id. Learn more about the multiple token combinations of each gateway from this document.\nEnter the value as true for the payment gateways that do not allow to retrieve the payment method details. Once passed, it will create payment method at Chargebee with the provided attributes in payment_method_token, customer_profile_token, network_transaction_id, mandate_id, card, and billing_address.
Note:\nCurrently, the skip_retrieval value as true is only supported for the Vantiv payment gateway.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device\n.The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/delete" : { "post" : { "summary" : "Delete a payment source", "description" : "Deletes a payment source. Once the payment source is deleted, if\n\n* **Deleted payment source is Primary, and Backup is available**\n * The Backup payment source will become the Primary payment source.\n* **Deleted payment source is Primary, and no Backup is available**\n * The other payment source available, but not assigned to any subscription, will become the Primary payment source.\n\n **Note** : *When multiple payment sources exist, the payment method added most recently will be considered*.\n * If other payment sources available are assigned to subscriptions, the auto collection attribute for the customer will be set to Off, and the events *card_deleted* and *payment_source_deleted* will be triggered.\n\n* **Deleted payment source is attached to subscriptions**\n * Dunning will be initiated for subscriptions attached to this payment source if auto collection is set to On, and when no customer default is present.\n\nIf there is no such payment source present in the gateway for the customer, this API will return successfully without throwing any error. \n**Note**\n:\n\nIf you delete the only available payment method of a customer in Chargebee, it also deletes the customer's record at the gateway. To delete the payment method locally(delete only in Chargebee), use [Local Delete a Payment Source API](/docs/api/payment_sources/local-delete-a-payment-source)\n.\n", "operationId" : "delete_a_payment_source", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "cust-payment-source-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/cust-payment-source-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_card" : { "post" : { "summary" : "Create a card payment source", "description" : "Storing card after successful 3DS completion is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources/create-using-payment-intent)\nunder Payment source to store the card after successful 3DS flow completion.\n", "operationId" : "create_a_card_payment_source", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "customer_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer with whom this payment source is associated.\n", "maxLength" : 50, "example" : null }, "replace_primary_payment_source" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Indicates whether the primary payment source should be replaced with this payment source.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n", "example" : null }, "card" : { "type" : "object", "deprecated" : false, "description" : "Parameters for card\n", "properties" : { "gateway_account_id" : { "type" : "string", "deprecated" : false, "description" : "The gateway account in which this payment source is stored.\n", "maxLength" : 50, "example" : null }, "first_name" : { "type" : "string", "deprecated" : false, "description" : "Cardholder's first name\n", "maxLength" : 50, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "Cardholder's last name\n", "maxLength" : 50, "example" : null }, "number" : { "type" : "string", "deprecated" : false, "description" : "The credit card number without any format. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)\n, you can specify the Braintree encrypted card number here.\n", "maxLength" : 1500, "example" : null }, "expiry_month" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Card expiry month.\n", "maximum" : 12, "minimum" : 1, "example" : null }, "expiry_year" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Card expiry year.\n", "example" : null }, "cvv" : { "type" : "string", "deprecated" : false, "description" : "The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js)\n, you can specify the Braintree encrypted CVV here.\n", "maxLength" : 520, "example" : null }, "preferred_scheme" : { "type" : "string", "deprecated" : false, "description" : "The customer's preferred card scheme for co-branded cards. \n**Note**:\nCurrently, this parameter is only supported for Stripe.\n\\* mastercard -\n\nA MasterCard scheme.\n\\* mada -\n\nA Mada card scheme.\n\\* cartes_bancaires -\n\nA Cartes Bancaires card scheme.\n\\* visa -\n\nA Visa card scheme.\n", "enum" : [ "cartes_bancaires", "mastercard", "visa" ], "example" : null }, "billing_addr1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1, as available in card billing address.\n", "maxLength" : 150, "example" : null }, "billing_addr2" : { "type" : "string", "deprecated" : false, "description" : "Address line 2, as available in card billing address.\n", "maxLength" : 150, "example" : null }, "billing_city" : { "type" : "string", "deprecated" : false, "description" : "City, as available in card billing address.\n", "maxLength" : 50, "example" : null }, "billing_state_code" : { "type" : "string", "deprecated" : false, "description" : "The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/verify_bank_account" : { "post" : { "summary" : "Verify bank account payment source", "description" : "This API can be used to verify bank accounts which have been added as payment source. This is applicable for **Stripe ACH with micro-deposit mode bank accounts** only. Stripe handles verification in two ways - via Plaid, and micro-deposit.\n\nFor verifying bank accounts via **micro-deposit**, Stripe deposits two small amounts to the bank account being added. These deposits will take 1-2 business days to appear on the customer's bank statement. The bank statement description for the two micro-deposits contains the amount and the values deposited. Your customer will need to relay the value of the two deposits to you, after which you can verify the bank account. Once the bank account has been verified, the payment source will be marked as \"Valid\". \nA maximum of 10 failed verification attempts are allowed. Once this limit has been crossed, the bank account can no longer be verified, and will be marked as \"Invalid\" in Chargebee.\n", "operationId" : "verify_bank_account_payment_source", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "cust-payment-source-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/cust-payment-source-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "amount1" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Value of the micro-deposits sent to the bank account.\n", "minimum" : 0, "example" : null }, "amount2" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Value of the micro-deposits sent to the bank account.\n", "minimum" : 0, "example" : null } }, "required" : [ "amount1", "amount2" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources" : { "get" : { "summary" : "List payment sources", "description" : "Lists all the payment sources\n", "operationId" : "list_payment_sources", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Unique subscription identifier that helps to retrieve the payment source of a subscription which has mandate\nassociated to it.
Indicates whether to include deleted objects in the list. The deleted objects have the attribute 'deleted\n' as 'true\n'.
Resource object representing third_party_payment_method
" } }, "required" : [ "third_party_payment_method" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_using_payment_intent" : { "post" : { "summary" : "Create using payment intent", "description" : "Used to attach the card to the customer after 3DS completion. [Learn more](/docs/api/3ds_card_payments)\non the 3DS implementation via Chargebee APIs.\n", "operationId" : "create_using_payment_intent", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "customer_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer with whom this payment source is associated.\n", "maxLength" : 50, "example" : null }, "replace_primary_payment_source" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Indicates whether the primary payment source should be replaced with this payment source.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n", "example" : null }, "payment_intent" : { "type" : "object", "deprecated" : false, "description" : "Parameters for payment_intent\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.\n", "maxLength" : 150, "example" : null }, "gateway_account_id" : { "type" : "string", "deprecated" : false, "description" : "The gateway account used for performing the 3DS flow. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n", "maxLength" : 50, "example" : null }, "gw_token" : { "type" : "string", "deprecated" : false, "description" : "Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n", "maxLength" : 65000, "example" : null }, "payment_method_type" : { "type" : "string", "deprecated" : false, "description" : "The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.\n\\* 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\\* 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\\* 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\\* trustly -\n\nTrustly\n\\* 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\\* 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" ], "example" : null }, "reference_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.\n", "maxLength" : 65000, "example" : null }, "additional_info" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "Applicable only for Braintree gateway. Can be used only for Braintree's Premium Fraud Management Tools.\nPass a stringified JSON containing the device_session_id\nand fraud_merchant_id\nas an input to fingerprint.\nHere's a sample\nto it.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}" : { "get" : { "summary" : "Retrieve a payment source", "description" : "Retrieves the payment source identified by the unique identifier.\n", "operationId" : "retrieve_a_payment_source", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "cust-payment-source-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/cust-payment-source-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_voucher_payment_source" : { "post" : { "summary" : "Create a voucher payment method", "description" : "Create a voucher payment method for the payment source.\n", "operationId" : "create_a_voucher_payment_method", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "customer_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer with whom this payment source is associated.\n", "maxLength" : 50, "example" : null }, "voucher_payment_source" : { "type" : "object", "deprecated" : false, "description" : "Parameters for voucher_payment_source\n", "properties" : { "voucher_type" : { "type" : "string", "deprecated" : false, "description" : "Voucher based payment methods\n\\* boleto -\n\nBoleto\n", "enum" : [ "boleto" ], "example" : null }, "gateway_account_id" : { "type" : "string", "deprecated" : false, "description" : "The gateway account to which the payment method is associated.\n", "maxLength" : 50, "example" : null }, "tax_id" : { "type" : "string", "deprecated" : false, "description" : "Customer Tax id\n", "maxLength" : 20, "example" : null }, "billing_address" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "The billing address of the customer. The value is a JSON object with the following keys and their values:- first_name:(string, max chars=150) The first name of the contact.
last_name:(string, max chars=150) The last name of the contact.line1:(string, max chars=180) The first line of the address.line2:(string, max chars=180) The second line of the address.country_code:(string, max chars=50) The two-letter, ISO 3166 alpha-2 country code for the address.state_code:(string, max chars=50) The ISO 3166-2 state/province code without the country prefix.For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).city:(string, max chars=50) The city name for the address.postal_code:(string, max chars=20) The postal or ZIP code for the address.phone:(string, max chars=50) The contact phone number for the address.email:(string, max chars=70) The contact email address for the address.Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_using_temp_token" : { "post" : { "summary" : "Create using gateway temporary token", "description" : "This API offers an alternative way to create a payment source using a single-use gateway temporary token, which is generally provided by your payment gateway. In the case of Stripe, this temporary token is generated according to the instruction detailed in [Stripe documentation](https://stripe.com/docs/api/tokens/create_card). \nStoring card after successful 3DS completion is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources/create-using-payment-intent)\nunder Payment source to store the card after successful 3DS flow completion.\n", "operationId" : "create_using_gateway_temporary_token", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "customer_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer with whom this payment source is associated.\n", "maxLength" : 50, "example" : null }, "gateway_account_id" : { "type" : "string", "deprecated" : false, "description" : "The gateway account to which the payment source is associated.\n", "maxLength" : 50, "example" : null }, "type" : { "type" : "string", "deprecated" : false, "description" : "Type of payment source.\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* direct_debit -\n\nRepresents bank account for which the direct debit or ACH agreement/mandate is created.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* venmo -\n\nPayments made via Venmo\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* sofort -\n\nPayments made via Sofort.\n\\* pix -\n\nPayments made via Pix\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* pay_co -\n\nPayments made via PayCo\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* trustly -\n\nTrustly\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* upi -\n\nUPI Payments.\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* bancontact -\n\nPayments made via Bancontact Card.\n\\* pay_to -\n\nPayments made via PayTo\n\\* go_pay -\n\nPayments made via GoPay\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* payme -\n\nPayments made via PayMe\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* giropay -\n\nPayments made via giropay.\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* pay_by_bank -\n\nPay By Bank\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* twint -\n\nPayments made via Twint\n\\* swish -\n\nPayments made via Swish\n", "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "apple_pay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna" ], "example" : null }, "tmp_token" : { "type" : "string", "deprecated" : false, "description" : "Single-use token created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.\n", "maxLength" : 65000, "example" : null }, "issuing_country" : { "type" : "string", "deprecated" : false, "description" : "2-letter (alpha2) ISO country code. Indicates your customer's payment method country of issuance. Applicable for PayPal via Braintree.\n", "maxLength" : 50, "example" : null }, "replace_primary_payment_source" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Indicates whether the primary payment source should be replaced with this payment source.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n", "example" : null }, "additional_information" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device\n.Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/update_card" : { "post" : { "summary" : "Update a card payment source", "description" : "Merchants look to update card details when:\n\n* The billing address of a customer has changed. In such a case, modify the billing address in the Chargebee and the payment gateway.\n* The expiration date of the card has been extended by the bank. (This usually happens when the date of card expiry is in near future).\n\nMultiple parameters such as address, expiry date, month, and so on, can be updated through this API.\n\nMeta data can also be added additionally(supported in Stripe only). Metadata is a JSON object. It is used to store additional information about customers.\n\nIn **Stripe** and **Braintree** payment gateways, changes in card details are auto-updated. This feature can also be used for other payment gateways in which auto-update is not enabled or is not supported by Chargebee. \n**Note**\n: This endpoint supports Chargebee Test Gateway, [Stripe](https://www.chargebee.com/docs/2.0/stripe.html)\n, [Braintree](https://www.chargebee.com/docs/2.0/braintree.html)\n, [Authorize.net](https://www.chargebee.com/docs/2.0/authorize-index.html)\n, [Worldpay US eCom](https://www.chargebee.com/docs/2.0/vantiv_worldpay.html)\n, and [WorldPay Direct Integration](https://www.chargebee.com/docs/2.0/worldpay-direct.html)\n. For all other gateways, your customers must re-enter the full [card details](/docs/api/payment_sources/update-a-card-payment-source#card_first_name)\nto update existing card details. For example, consider a customer not using the gateways mentioned above and wants to update the [card\\[billing_addr1\\]](/docs/api/payment_sources/update-a-card-payment-source#card_billing_addr1)\nparameter. In such a case, the customer must re-enter the value of all the parameters present in the [card](/docs/api/payment_sources/update-a-card-payment-source#card_first_name)\nobject.\n", "operationId" : "update_a_card_payment_source", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "cust-payment-source-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/cust-payment-source-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "gateway_meta_data" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "Additional data about this resource can be passed to \\*\\*Stripe\\*\\* gateway here in the JSON Format. This will be stored along with payment source at the gateway account.\n", "example" : null }, "reference_transaction" : { "type" : "string", "deprecated" : false, "description" : "Reference transaction is used for future purchases. This is only applicable for Vantiv.\n", "maxLength" : 50, "example" : null }, "card" : { "type" : "object", "deprecated" : false, "description" : "Parameters for card\n", "properties" : { "first_name" : { "type" : "string", "deprecated" : false, "description" : "Cardholder's first name\n", "maxLength" : 50, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "Cardholder's last name\n", "maxLength" : 50, "example" : null }, "expiry_month" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Card expiry month.\n", "maximum" : 12, "minimum" : 1, "example" : null }, "expiry_year" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Card expiry year.\n", "example" : null }, "billing_addr1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1, as available in card billing address.\n", "maxLength" : 150, "example" : null }, "billing_addr2" : { "type" : "string", "deprecated" : false, "description" : "Address line 2, as available in card billing address.\n", "maxLength" : 150, "example" : null }, "billing_city" : { "type" : "string", "deprecated" : false, "description" : "City, as available in card billing address.\n", "maxLength" : 50, "example" : null }, "billing_zip" : { "type" : "string", "deprecated" : false, "description" : "Postal or Zip code, as available in card billing address.\n", "maxLength" : 20, "example" : null }, "billing_state_code" : { "type" : "string", "deprecated" : false, "description" : "The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
ebanx: While passing raw card details to EBANX, the user's document is required for some countries.
payer: User related information.\ndocument: Document is the user's identification number based on their country.Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/switch_gateway_account" : { "post" : { "summary" : "Switch gateway account", "description" : "Moves a card payment source from one gateway account to another.
Use this operation to migrate payment methods between gateway accounts, such as when:
See the Use Cases section for the list of supported source-destination gateway combinations.
reference_idThis operation updates the reference_id attribute of the payment source. In case you are using this value for any downstream system integrations, you will need to update the reference_id for the payment source in the downstream system to the new value.
payment_source.type must be card.gateway_account_idgatewayreference_idThe API supports only the following source-destination gateway combinations:
| Source | Destination |
|---|---|
Any of the gateways via Spreedly. These include Authorize.net, Bambora, BlueSnap, Moneris, Orbital (Chase Paymentech), Paymill, PayPal Payments Pro, PayPal Payflow Pro, SagePay, Worldline Online Payments, Worldpay. |
|
| PayPal Express Checkout | PayPal Commerce |
Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_using_token" : { "post" : { "summary" : "Create using Chargebee token", "description" : "Storing card after successful 3DS completion is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources/create-using-payment-intent)\nunder Payment source to store the card after successful 3DS flow completion.\n", "operationId" : "create_using_chargebee_token", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "customer_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer with whom this payment source is associated.\n", "maxLength" : 50, "example" : null }, "replace_primary_payment_source" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Indicates whether the primary payment source should be replaced with this payment source.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n", "example" : null }, "token_id" : { "type" : "string", "deprecated" : false, "description" : "Token generated by Chargebee JS representing payment method details.\n", "maxLength" : 40, "example" : null } }, "required" : [ "customer_id", "token_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/delete_local" : { "post" : { "summary" : "Local delete a payment source", "description" : "Delete a payment source reference from a Chargebee customer without deleting or altering payment source data stored at the payment gateway.
Payment Source
Sets deleted = true on the specified payment_source and detaches it from the customer. The payment source is no longer accessible through the API or the UI.
Customer
If the deleted payment_source is the customer's only payment method and auto_collection is on, automatic payment collection for future invoices fails.
If the deleted payment source was the primary payment method for the customer, and a backup exists, Chargebee promotes the backup to primary.
If no backup is set but other payment_source objects exist for the customer, Chargebee promotes one of them to primary.
Subscription
When you delete a payment source linked to an active subscription, Chargebee immediately clears the payment_source_id on that subscription. Future charges use the customer's primary_payment_source_id.
Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_bank_account" : { "post" : { "summary" : "Create a bank account payment source", "description" : "This API adds a Direct Debit payment source for a customer. The bank account details collected from your customer are passed as input to this API.
ACH is an electronic network for passing financial transactions in the US. Chargebee currently supports ACH via Stripe , Authorize.Net, and GoCardless.
Note:
chargebee-request-origin-ip) and the device information(chargebee-request-origin-device).Once the bank account has been added, it needs to be verified.
SEPA is an initiative that integrates bank transfer payments denominated in euro. It is supported via GoCardless, Stripe and Adyen.
Note:
Bacs is an organization that manages the Direct Debit and Direct Credit payment methods in the UK. Bg Autogiro is a Direct Debit scheme for krona denominated payments in Sweden. Both Bacs and Bg Autogiro are supported via GoCardless.
Note:
chargebee-request-origin-ip) and the device information(chargebee-request-origin-device).BECS is an automated payment method for Direct Debit in Australia and New Zealand while PAD does the same for Canada. GoCardless supports both.
For Direct Debit, the customer needs to accept a mandate that allows the merchant to debit their bank account. This agreement PDF can be obtained using the Retrieve direct debit agreement PDF API.
If the customer has already reached the payment source limit allowed for the site, pass replace_primary_payment_source as true. Alternatively, delete one of the payment sources first and then add the bank account payment source for the customer.
Note:
chargebee-request-origin-ip) and the device information(chargebee-request-origin-device).The billing address associated with the bank account. The value is a JSON object with the following keys and their values:- first_name:(string, max chars=150) The first name of the contact.
last_name:(string, max chars=150) The last name of the contact.company_name:(string, max chars=250) The company name for the address.line1:(string, max chars=180) The first line of the address.line2:(string, max chars=180) The second line of the address.country:(string) The name of the country for the address.country_code:(string, max chars=50) The two-letter, ISO 3166 alpha-2 country code for the address.state:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, and India.state_code:(string, max chars=50) The ISO 3166-2 state/province code without the country prefix. This is supported for USA, Canada, and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).city:(string, max chars=50) The city name for the address.postal_code:(string, max chars=20) The postal or ZIP code for the address.phone:(string, max chars=50) The contact phone number for the address.email:(string, max chars=70) The contact email address for the address.Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/update_bank_account" : { "post" : { "summary" : "Update a bank account payment source", "description" : "This API is used to update the payment source details of a customer. Information related to bank account payment source such as email, first name, and last name can be updated.
The API is only supported for the payment_method of type direct_debit.
Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/virtual_bank_accounts/{virtual-bank-account-id}/delete_local" : { "post" : { "summary" : "Local delete a virtual bank account", "description" : "Deletes virtual bank accounts from Chargebee. Payment method in the payment gateway, and Auto Collection settings in Chargebee are not affected.\n", "operationId" : "local_delete_a_virtual_bank_account", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "virtual-bank-account-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/virtual-bank-account-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "virtual_bank_account" : { "$ref" : "#/components/schemas/VirtualBankAccount", "description" : "Resource object representing virtual_bank_account
" } }, "required" : [ "virtual_bank_account" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/virtual_bank_accounts/{virtual-bank-account-id}/delete" : { "post" : { "summary" : "Delete a virtual bank account", "description" : "Deletes a virtual bank account. If there is no virtual bank account present in the gateway for the customer, this API will return successfully without throwing an error.\n", "operationId" : "delete_a_virtual_bank_account", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "virtual-bank-account-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/virtual-bank-account-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "virtual_bank_account" : { "$ref" : "#/components/schemas/VirtualBankAccount", "description" : "Resource object representing virtual_bank_account
" } }, "required" : [ "virtual_bank_account" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/virtual_bank_accounts" : { "get" : { "summary" : "List virtual bank accounts", "description" : "Lists all the virtual bank accounts.\n", "operationId" : "list_virtual_bank_accounts", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Identifier of the gateway account to use when creating the virtual bank account.
\nDefault behavior\nWhen not provided, Chargebee selects an applicable gateway account for the chosen scheme. Selection follows your site's Smart Routing rules.
Type of the credit transfer.
\n* mx_automated_bank_transfer -MX Automated Bank Transfer
\n* sepa_credit -SEPA Credit Transfer
\nThis scheme is deprecated. Instead of sepa_credit\nuse eu_automated_bank_transfer\n.
EU Automated Bank Transfer
\n* ach_credit -ACH Credit Transfer
\nThis scheme is deprecated. Instead of ach_credit\nuse us_automated_bank_transfer\n.
JP Automated Bank Transfer
\n* us_automated_bank_transfer -US Automated Bank Transfer
\n* gb_automated_bank_transfer -UK Automated Bank Transfer
", "enum" : [ "ach_credit", "sepa_credit", "us_automated_bank_transfer", "gb_automated_bank_transfer", "eu_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer" ], "example" : null } }, "required" : [ "customer_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "virtual_bank_account" : { "$ref" : "#/components/schemas/VirtualBankAccount", "description" : "Resource object representing virtual_bank_account
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" } }, "required" : [ "virtual_bank_account" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/virtual_bank_accounts/{virtual-bank-account-id}" : { "get" : { "summary" : "Retrieve a virtual bank account", "description" : "Retrieves the virtual bank account identified by the unique identifier.\n", "operationId" : "retrieve_a_virtual_bank_account", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "virtual-bank-account-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/virtual-bank-account-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "virtual_bank_account" : { "$ref" : "#/components/schemas/VirtualBankAccount", "description" : "Resource object representing virtual_bank_account
" } }, "required" : [ "virtual_bank_account" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/virtual_bank_accounts/create_using_permanent_token" : { "post" : { "summary" : "Create a virtual bank account using permanent token", "description" : "Creates a virtual bank account (VBA) for a customer using a permanent token obtained from a payment gateway.
Use this operation when you have already created a payment source at the gateway and obtained a permanent token (reference ID) for it.
scheme. For example, if the customer already has a VBA with scheme set to us_automated_bank_transfer, you cannot create another VBA with the same scheme.Virtual bank account
customer.email attribute. Later, if the email address is updated for the customer, the email address for the VBA is also updated.Check if the customer already has a virtual bank account for the same scheme by calling the List virtual bank accounts API with the customer ID filter. If a virtual bank account exists for the same scheme, the API returns a payment_method_already_exists error.
Validate that the required currency for the scheme is enabled. Use the List currencies API to check if the currency is enabled.
\nThe identifier (permanent token) used to fetch the payment source details from the gateway. For example, in Stripe it may be only the Stripe Customer ID (for example, cus_63MnDn0t6kfDW7), or a combination of Stripe Customer ID and Stripe Source ID separated by a forward slash (for example, cus_63MnDn0t6kfDW7/src_6WjCF20vT9WN1G).
\nConstraints
gateway_account_id is provided, the reference_id must belong to the gateway account.gateway_account_id is not provided, the reference_id must belong to the gateway account selected based on the gateway routing rules for the payment method type and currency combination.Identifier of the payment gateway account to use when creating the virtual bank account.
\nDefault behavior\nWhen not provided, Chargebee selects an applicable gateway account for the chosen scheme. Selection follows your site's Smart Routing rules.
The type of automated bank transfer scheme for the virtual bank account.
\nPrerequisites
Mexico Automated Bank Transfer scheme for Mexico-based customers.
\nPrerequisites
billing_address.country must be MX.Deprecated
eu_automated_bank_transfer instead.SEPA Credit Transfer scheme for customers in the European Union.
\n* eu_automated_bank_transfer -EU Automated Bank Transfer scheme for customers in the European Union.
\nPrerequisites
billing_address.country must be in a SEPA-supported region.Deprecated
us_automated_bank_transfer instead.ACH Credit Transfer scheme for US-based customers.
\n* jp_automated_bank_transfer -Japan Automated Bank Transfer scheme for Japan-based customers.
\nPrerequisites
billing_address.country must be JP.US Automated Bank Transfer scheme for US-based customers.
\nPrerequisites
billing_address.country must be US.US Automated Bank Transfer
\n* gb_automated_bank_transfer -UK Automated Bank Transfer scheme for UK-based customers.
\nPrerequisites
billing_address.country must be GB.Resource object representing virtual_bank_account
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" } }, "required" : [ "virtual_bank_account" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/copy_card" : { "post" : { "summary" : "Copy card", "description" : "#### deprecated\n\nThe [Payment Sources API](/docs/api/payment_sources)\n, with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the [Export payment source API](/docs/api/payment_sources/export-payment-source)\n.\n\nCopies the customer's card information to another payment gateway. This is useful if you want to port your customer's card details to another gateway. \n**Limitation**\n\nThis request does not support copying of cards between Braintree and Stripe payment gateways. Contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)\nto perform those actions.\n", "operationId" : "copy_card", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "customer-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/customer-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "gateway_account_id" : { "type" : "string", "deprecated" : false, "description" : "The gateway account you want to copy the card.\n", "maxLength" : 50, "example" : null } }, "required" : [ "gateway_account_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "third_party_payment_method" : { "$ref" : "#/components/schemas/ThirdPartyPaymentMethod", "description" : "Resource object representing third_party_payment_method
" } }, "required" : [ "third_party_payment_method" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/cards/{customer-id}" : { "get" : { "summary" : "Retrieve card for a customer", "description" : "#### Deprecated\n\nThis operation is obsoleted by the [Retrieve a payment source API](/docs/api/payment_sources/retrieve-a-payment-source)\n.\n\nRetrieves the credit card for the customer id.\n", "operationId" : "retrieve_card_for_a_customer", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "customer-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/customer-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "card" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/switch_gateway" : { "post" : { "summary" : "Switch gateway", "description" : "This request is obsoleted by the Switch gateway account API\nfor Payment Sources.
Switches the gateway in which customer's card information is stored. This is applicable only if the payment method is card.
Limitation
This request does not support switching between Braintree and Stripe payment gateways. Contact Chargebee Support\nto perform those actions.
Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "card", "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/delete_card" : { "post" : { "summary" : "Delete card for a customer", "description" : "The Payment Sources API\n, with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the Delete a payment source API\n.
Deletes the card for a customer. Upon successful deletion the auto_collection attribute for the customer is set to off and a card_deleted event is triggered. If there is no card found at the gateway for the customer, this API returns without errors.
Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/credit_card" : { "post" : { "summary" : "Update card for a customer", "description" : "The Payment Sources API\n, with its additional options and improvements, obsoletes the Cards APIs\n. This operation is obsoleted by the following:
Adds or replaces card details of a customer. Updating card details replaces the present payment method.
Passing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable
Legacy behavior:
billing_address and vat_number of the customer are deleted and replaced by the values passed with this request. Ensure that you pass the billing address parameters and the vat_number parameters each time you make this request, to avoid losing the same information at the customer-level.billing_address and vat_number of the customer.The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
.
", "maxLength" : 50, "example" : null } }, "required" : [ "expiry_month", "expiry_year", "number" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "card", "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/promotional_credits/{account-credit-id}" : { "get" : { "summary" : "Retrieve a promotional credit", "description" : "This endpoint retrieves the promotional credit based on the promotional credit id\n", "operationId" : "retrieve_a_promotional_credit", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "account-credit-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/account-credit-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "promotional_credit" : { "$ref" : "#/components/schemas/PromotionalCredit", "description" : "Resource object representing promotional_credit
" } }, "required" : [ "promotional_credit" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/promotional_credits" : { "get" : { "summary" : "List promotional credits", "description" : "This endpoint lists the promotional credits set for a customer\n", "operationId" : "list_promotional_credits", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Resource object representing customer
" }, "promotional_credit" : { "$ref" : "#/components/schemas/PromotionalCredit", "description" : "Resource object representing promotional_credit
" } }, "required" : [ "customer", "promotional_credit" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/promotional_credits/set" : { "post" : { "summary" : "Set Promotional Credits", "description" : "This API call can be used to set the promotional credits balance of a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).\n\nFor example,\n\n* If a customer has a credit balance of $10 and if you would like to set the balance to $100, you could pass the **amount** as $100.\n* If a customer has a credit balance of $10 and if you would like to set the balance to $5, you could pass the **amount** as $5.\n* If a customer has a credit balance of $10 and if you would like to clear the balance, you could pass the **amount** as $0.\n", "operationId" : "set_promotional_credits", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "customer_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer.\n", "maxLength" : 50, "example" : null }, "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Promotional credits amount.\n", "minimum" : 0, "example" : null }, "amount_in_decimal" : { "type" : "string", "deprecated" : false, "description" : "Amount in decimal.\n", "maxLength" : 33, "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "The currency code (ISO 4217 format) for promotional credit.\n", "maxLength" : 3, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "Detailed description of this promotional credits.\n", "maxLength" : 250, "example" : null }, "credit_type" : { "type" : "string", "default" : "general", "deprecated" : false, "description" : "Type of promotional credits provided to customer. \\\\\\* general - General \\\\\\* referral_rewards - Referral \\\\\\* loyalty_credits - Loyalty Credits\n", "enum" : [ "loyalty_credits", "referral_rewards", "general" ], "example" : null }, "reference" : { "type" : "string", "deprecated" : false, "description" : "Describes why promotional credits were provided.\n", "maxLength" : 500, "example" : null } }, "required" : [ "customer_id", "description" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "promotional_credit" : { "$ref" : "#/components/schemas/PromotionalCredit", "description" : "Resource object representing promotional_credit
" } }, "required" : [ "customer", "promotional_credit" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/promotional_credits/add" : { "post" : { "summary" : "Add Promotional Credits", "description" : "This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).\n\nFor example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer's credit balance would become $20.\n", "operationId" : "add_promotional_credits", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "customer_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer.\n", "maxLength" : 50, "example" : null }, "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Promotional credits amount.\n", "minimum" : 0, "example" : null }, "amount_in_decimal" : { "type" : "string", "deprecated" : false, "description" : "Amount in decimal.\n", "maxLength" : 33, "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "The currency code (ISO 4217 format) for promotional credit.\n", "maxLength" : 3, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "Detailed description of this promotional credits.\n", "maxLength" : 250, "example" : null }, "credit_type" : { "type" : "string", "default" : "general", "deprecated" : false, "description" : "Type of promotional credits provided to customer. \\\\\\* general - General \\\\\\* referral_rewards - Referral \\\\\\* loyalty_credits - Loyalty Credits\n", "enum" : [ "loyalty_credits", "referral_rewards", "general" ], "example" : null }, "reference" : { "type" : "string", "deprecated" : false, "description" : "Describes why promotional credits were provided.\n", "maxLength" : 500, "example" : null } }, "required" : [ "customer_id", "description" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "promotional_credit" : { "$ref" : "#/components/schemas/PromotionalCredit", "description" : "Resource object representing promotional_credit
" } }, "required" : [ "customer", "promotional_credit" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/delete_line_items" : { "post" : { "summary" : "Delete Line Items", "description" : "This endpoint is used to delete line items from \"Pending\" invoice.\n", "operationId" : "delete_line_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "invoice-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/invoice-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "line_items" : { "type" : "object", "deprecated" : false, "description" : "The list of line items which have to be deleted.\n", "properties" : { "id" : { "type" : "array", "description" : "Uniquely identifies a line_item\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 40, "example" : null }, "example" : null } }, "example" : null } }, "example" : null }, "encoding" : { "line_items" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/remove_credit_note" : { "post" : { "summary" : "Remove credit note from an invoice", "description" : "Removes the specified adjustment credit or refundable credit allocation applied to the invoice.
voided or pending.voided.adjustment or refundable.Invoice
amount_due increases by the allocations[i].allocated_amount of the credit note.amount_adjusted decreases by the allocations[i].allocated_amount of the credit note if the credit_note.type is adjustment.write_off_amount decreases by the allocations[i].allocated_amount of the credit note if the credit_note.create_reason_code is Write Off.payment_due, not_paid, or posted, the status does not change after the credit note is removed.paid:\nposted if the due_date is in the future.not_paid if the due date is in the past.Credit note
amount_allocated decreases and the amount_available increases by the allocations[i].allocated_amount, where i is such that allocations[i].invoice_id = invoice.id.Before you call this API, make sure that:
voided or pending.voided.adjustment or refundable.credit_note.allocations[i].allocated_amount where credit_note.allocations[i].invoice_id == invoice.id.invoice.amount_paid.invoice.applied_credits[i].applied_amountinvoice.linked_taxes_withheld[i].amountinvoice.issued_credit_notes[i].cn_totalResource object representing invoice
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "credit_note", "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/remove_payment" : { "post" : { "summary" : "Remove payment from an invoice", "description" : "Removes a payment transaction that was applied to an invoice and moves the amount to the customer's excess payments balance.
This API does not refund the payment to the customer. To refund a payment transaction, use one of the following APIs:
issued_credit_notes with a cn_status value of refunded or refund_due for the invoice.linked_payments[].txn_id for the invoice.status of the transaction must be success, in_progress, or needs_attention.Invoice
amount_due on the invoice increases by the amount of the removed payment.payment_due, not_paid, or posted, the status does not change after a payment is removed.paid:\nposted if the due_date is in the future.payment_due if the due_date is in the past and auto_collection is off, or if auto_collection is on and dunning is in progress for the invoice.not_paid if the due date is in the past, auto_collection is on, and dunning was not in progress for the invoice.Transaction
The amount_unused on the transaction increases by the amount of the removed payment.
Customer excess payments balance
The customer's excess_payments balance increases by the amount of the removed payment.
Invoice dunning process
payment_due before this operation, and dunning was in progress for the invoice, the dunning process continues as configured.paid before this operation, the dunning process does not resume.Before you call this API, make sure that:
issued_credit_notes with a cn_status value of refunded or refund_due for the invoice.linked_payments[].txn_id for the invoice.status of the transaction is success, in_progress, or needs_attention.Can I remove payments from multiple invoices at once?
Yes. To remove payments from multiple invoices in bulk, go to Settings > Import > Export Data > Bulk Operation, and select Remove payment from Invoice.
How can I track the history of payments removed from invoices?
You can view the history of payments removed from invoices in the Activity Log section of the invoice. The log shows all actions taken, including payments removed.
Resource object representing invoice
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "invoice", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/stop_dunning" : { "post" : { "summary" : "Stop dunning for invoice", "description" : "This API is used to stop dunning for \"Payment Due\" invoices that have been enabled for Auto Collection. When dunning is stopped, the status of the invoice will be changed to \"Not Paid\".\n", "operationId" : "stop_dunning_for_invoice", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "invoice-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/invoice-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "comment" : { "type" : "string", "deprecated" : false, "description" : "An internal [comment](/docs/api/comments)\nto be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)\nor any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)\n.\n", "maxLength" : 300, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/apply_payments" : { "post" : { "summary" : "Apply payments for an invoice", "description" : "Applies payment to a single invoice. You can either specify individual payment transactions as parameters, or Chargebee applies any available excess payments for that customer. If you specify individual transactions then any un-applied amount in those transactions will be used.
status must be payment_due, posted, or not_paid.Invoice
Invoice's amount_due is updated to reflect the applied payment. If no amount remains, the invoice status becomes paid.
Transactions
When a payment is applied to an invoice, the amount_unused field of the associated transaction(s) is reduced accordingly.
Accounting Integrations
Synchronization to the accounting system will not proceed if the linked transaction contains a surplus balance.
Before calling this API, ensure the following:
invoice status is not_paid, payment_due, or posted.Specifies the amount from the transaction to apply as a payment towards the invoice. The amount applied is the smallest of the following values: the amount you specify for this parameter, transactions.unused_amount\n, or invoice.amount_due\n.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/apply_payment_schedule_scheme" : { "post" : { "summary" : "Apply payment schedule scheme to an invoice", "description" : "Applying a payment schedule scheme to an invoice creates payment schedules, enabling the invoice to be paid in multiple, scheduled payments.
Note:\nThe invoice must be in payment_due\n.
The identifier of the payment_schedule_scheme\n, used to create the payment schedules.
The part of the invoice.amount_due\nto be distributed across the payment schedules. If not specified, the entire invoice.amount_due\nis considered by default.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/void" : { "post" : { "summary" : "Void an invoice", "description" : "Voids the specified invoice.
Use this operation when:
Voiding preserves the audit trail and allows for future reference and compliance without removing the original record.
status must be payment_due, posted, or not_paid.linked_payments with txn_status set to success or in_progress.amount_adjusted on the invoice must be zero.applied_credits with cn_status set to refunded or refund_due.issued_credit_notes with cn_status set to refunded or refund_due.linked_taxes_withheld.Invoices
status to voided.Subscription
Customer
customer.balances.promotional_credits.Credit Note
type is adjustment.status is adjusted.create_reason_code is Invoice Void.Usages
usage resources associated with the invoice by clearing the invoice_id attribute.Integrations
Before calling this API, ensure the following:
status is payment_due, posted, or not_paid.linked_payments with txn_status set to success or in_progress.applied_credits with cn_status set to refunded or refund_dueissued_credit_notes with cn_status set to refunded or refund_dueadjustment_credit_notes with cn_status set to adjustedlinked_taxes_withheld.Resource object representing invoice
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/add_charge" : { "post" : { "summary" : "Add one-time charge to a pending invoice", "description" : "Adds a one-time charge to a pending invoice. A one-time charge is a charge that is added ad hoc to the invoice and does not represent a predefined item price. It appears in the invoice as a line_item of entity_type adhoc.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/send_einvoice" : { "post" : { "summary" : "Send an einvoice for invoices", "description" : "This endpoint is used to send an e-invoice for invoice.\nTo support cases like TDS and invoice edits, we need to stop auto e-invoice sending and be able to send e-invoices manually.\nThis endpoint schedules e-invoices manually. This operation is not allowed when any of the following condition matches:
If e-invoicing is not enabled at the site and customer level.
\nIf there is an e-invoice generated already for the invoice.
\nIf the Use automatic e-invoicing option is selected.
\nIf there are no generated e-invoices with the failed or skipped status.
If the invoice status is voided or pending.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/payment_schedules" : { "get" : { "summary" : "Retrieve payment schedules for an invoice", "description" : "This endpoint retrieves payment schedules created for an invoice.\n", "operationId" : "retrieve_payment_schedules_for_an_invoice", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "invoice-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/invoice-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "payment_schedules" : { "type" : "array", "description" : "Resource object representing payment_schedule
", "items" : { "$ref" : "#/components/schemas/PaymentSchedule", "description" : "Resource object representing payment_schedule" }, "example" : null } }, "required" : [ "payment_schedules" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/write_off" : { "post" : { "summary" : "Write off an invoice", "description" : "Write off the specified invoice.
Use this operation to mark invoices as settled when they remain unpaid after multiple attempts to collect payment.
You can reverse the write-off by removing the linked credit note.
status must be payment_due, posted, or not_paid.Invoice
status to paid.write_off_amount to the invoice amount_due.Credit Note
type is adjustment.create_reason_code is Write Off.total is invoice.amount_due.Payment Schedules
payment_schedule created against it, Chargebee marks the schedule as paid. Chargebee sets schedule_entries[].status to paid.RevRec
Before calling this API, ensure the following:
invoice.status is payment_due, posted, or not_paid.invoice.linked_payments[i].txn_status is not in_progress. If it is, then wait for the txn_status to be finalized.Resource object representing invoice
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "credit_note", "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/add_charge_item" : { "post" : { "summary" : "Add a charge-item to a pending invoice", "description" : "This endpoint is used when metered billing is enabled and it adds a charge-item price to a pending invoice. To collect the accumulated charges by closing the invoice, call Close a pending invoice.
The price or per-unit-price of the item price. By default, it is the value set\nfor the item_price.\nThis is only applicable when the pricing_model\nof the item_price\nis flat_fee\nor per_unit.\nThe value depends on the type of currency\n.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/pause_dunning" : { "post" : { "summary" : "Pause dunning for invoice", "description" : "Pause dunning for the specified invoice until expected_payment_date. Chargebee cancels all configured payment collection retry attempts and dunning email notifications for the invoice until expected_payment_date.
This operation is only permitted for an invoice that meets all the following conditions:
payment_due.auto_collection set to on.Unless you resume dunning for the invoice, Chargebee attempts to collect payment on the expected_payment_date. If payment collection fails, the next action is taken as follows:
expected_payment_date is within the dunning period for the invoice, Chargebee resumes any dunning retries and email notifications that remain after the pause period, and not attempt the retries or notifications that were canceled during the pause period.expected_payment_date is after the dunning period for the invoice, the final action configured in Billing is initiated for the invoice and, if applicable, for the subscription.Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices" : { "get" : { "summary" : "List invoices", "description" : "Lists all the Invoices.\n", "operationId" : "list_invoices", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.optional, in cents filter
\nPayments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.\nSupported operators :\nis, is_not, lt, lte, gt, gte, between
Example →\namount_paid[lt] = "800"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "800", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } } }, { "name" : "amount_adjusted", "in" : "query", "description" : "optional, in cents filter\n\nTotal adjustments made against this invoice.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*amount_adjusted\\[gte\\] = \"100\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "100", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } } }, { "name" : "credits_applied", "in" : "query", "description" : "optional, in cents filter\n\nTotal credits applied against this invoice.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*credits_applied\\[lte\\] = \"100\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "100", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } } }, { "name" : "amount_due", "in" : "query", "description" : "optional, in cents filter
\nThe unpaid amount that is due on the invoice. This is calculated as: total
amount_paid\napplied_credits.applied_amountadjustment_credit_notes.cn_totallinked_taxes_withheld.amount.\nSupported operators :\nis, is_not, lt, lte, gt, gte, betweenExample →\namount_due[lt] = "200"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "200", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } } }, { "name" : "dunning_status", "in" : "query", "description" : "optional, enumerated string filter\n\nCurrent dunning status of the invoice. Possible values are : in_progress, exhausted, stopped, success.\n\n**Supported operators :**\nis, is_not, in, not_in, is_present\n\n**Example →**\n*dunning_status\\[is\\] = \"in_progress\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "in_progress", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`in_progress\\` - Dunning is still in progress. \\* \\`exhausted\\` - Maximum number of attempts have been made. \\* \\`stopped\\` - Dunning has stopped for this invoice. \\* \\`success\\` - Payment successfully collected during dunning process.\n", "enum" : [ "in_progress", "exhausted", "stopped", "success" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`in_progress\\` - Dunning is still in progress. \\* \\`exhausted\\` - Maximum number of attempts have been made. \\* \\`stopped\\` - Dunning has stopped for this invoice. \\* \\`success\\` - Payment successfully collected during dunning process.\n", "enum" : [ "in_progress", "exhausted", "stopped", "success" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`in_progress\\` - Dunning is still in progress. \\* \\`exhausted\\` - Maximum number of attempts have been made. \\* \\`stopped\\` - Dunning has stopped for this invoice. \\* \\`success\\` - Payment successfully collected during dunning process.\n", "enum" : [ "in_progress", "exhausted", "stopped", "success" ], "pattern" : "^\\[(in_progress|exhausted|stopped|success)(,(in_progress|exhausted|stopped|success))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`in_progress\\` - Dunning is still in progress. \\* \\`exhausted\\` - Maximum number of attempts have been made. \\* \\`stopped\\` - Dunning has stopped for this invoice. \\* \\`success\\` - Payment successfully collected during dunning process.\n", "enum" : [ "in_progress", "exhausted", "stopped", "success" ], "pattern" : "^\\[(in_progress|exhausted|stopped|success)(,(in_progress|exhausted|stopped|success))*\\]$", "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "payment_owner", "in" : "query", "description" : "optional, string filter\n\nPayment owner of an invoice.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*payment_owner\\[is\\] = \"payment_customer\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "payment_customer", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "updated_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\nTo filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[after] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "channel", "in" : "query", "description" : "optional, enumerated string filter\n\nThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*channel\\[is\\] = \"APP STORE\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "APP STORE", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null } } } }, { "name" : "voided_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter\n\nTimestamp indicating the date \\& time this invoice got voided.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*voided_at\\[on\\] = \"1394532759\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1394532759", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "void_reason_code", "in" : "query", "description" : "optional, string filter\n\nReason code for voiding the invoice. Select from a list of reason codes set in the Chargebee app in **Settings \\> Configure Chargebee \\> Reason Codes \\> Invoices \\> Void invoice** .\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*void_reason_code\\[is_not\\] = \"Other\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "Other", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\ndate, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"date\"*\n\nThis will sort the result based on the 'date' attribute in ascending(earliest first) order.\n", "required" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "asc" : { "type" : "string", "enum" : [ "date", "updated_at" ], "example" : null }, "desc" : { "type" : "string", "enum" : [ "date", "updated_at" ], "example" : null } }, "example" : null } }, { "name" : "exclude", "in" : "query", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "line_items", "properties" : { "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "einvoice", "in" : "query", "description" : "Parameters for einvoice\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "status" : { "type" : "object", "deprecated" : false, "description" : "The status of processing the e-invoice. To obtain detailed information about the current status\n, see message\n.
entity_identifier is not registered on the e-invoicing network.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.",
"enum" : [ "scheduled", "skipped", "in_progress", "success", "failed", "registered", "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `scheduled` - Sending the e-invoice to the customer has been scheduled.\n* `skipped` - The e-invoice was not sent. This could be due to missing information or because the entity_identifier is not registered on the e-invoicing network.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.",
"enum" : [ "scheduled", "skipped", "in_progress", "success", "failed", "registered", "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `scheduled` - Sending the e-invoice to the customer has been scheduled.\n* `skipped` - The e-invoice was not sent. This could be due to missing information or because the entity_identifier is not registered on the e-invoicing network.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.",
"enum" : [ "scheduled", "skipped", "in_progress", "success", "failed", "registered", "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ],
"pattern" : "^\\[(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid)(,(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `scheduled` - Sending the e-invoice to the customer has been scheduled.\n* `skipped` - The e-invoice was not sent. This could be due to missing information or because the entity_identifier is not registered on the e-invoicing network.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.",
"enum" : [ "scheduled", "skipped", "in_progress", "success", "failed", "registered", "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ],
"pattern" : "^\\[(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid)(,(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid))*\\]$",
"example" : null
}
}
}
},
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"invoice" : {
"$ref" : "#/components/schemas/Invoice",
"description" : "Resource object representing invoice"
}
},
"required" : [ "invoice" ],
"example" : null
},
"example" : null
},
"next_offset" : {
"type" : "string",
"description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.",
"maxLength" : 1000,
"example" : null
}
},
"required" : [ "list" ],
"example" : null
}
}
}
},
"400" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/400"
}
}
}
},
"401" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/401"
}
}
}
},
"403" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/403"
}
}
}
},
"404" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/404"
}
}
}
},
"405" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/405"
}
}
}
},
"409" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/409"
}
}
}
},
"422" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/422"
}
}
}
},
"429" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/429"
}
}
}
},
"500" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/500"
}
}
}
},
"503" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/503"
}
}
}
}
},
"deprecated" : false,
"security" : [ {
"BasicAuth" : [ ]
} ]
}
},
"/invoices/{invoice-id}/close" : {
"post" : {
"summary" : "Close a pending invoice",
"description" : "Invoices for a subscription are created with a pending status when the subscription has create_pending_invoices attribute set to true. This API call finalizes a pending invoice. Any refundable_credits and excess_payments for the customer are applied to the invoice, and any payment due is collected automatically if auto_collection is on for the customer.
This operation can be automated by using a site setting. Moreover, the automation can be overridden at the customer and subscription level.
Set as true\nto remove the general note\nfrom this invoice.
Type of entity to which the note\nbelongs. To remove the general note, use the remove_general_note\nparameter.
Entity that represents a customer.
\n* plan -Entity that represents a plan.
\n* charge_item_price -Indicates that this line item is based on charge Item Price
\n* coupon -Entity that represents a coupon.
\n* addon -Entity that represents an addon.
\n* addon_item_price -Indicates that this line item is based on addon Item Price
\n* subscription -Entity that represents a subscription of customer.
\n* plan_item_price -Indicates that this line item is based on plan Item Price
", "enum" : [ "customer", "subscription", "coupon", "plan_item_price", "addon_item_price", "charge_item_price" ], "example" : null }, "example" : null }, "entity_id" : { "type" : "array", "description" : "Unique identifier of the [note](/docs/api/invoices/invoice-object#notes)\n.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null } }, "example" : null } }, "example" : null }, "encoding" : { "notes_to_remove" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/apply_credits" : { "post" : { "summary" : "Apply credits for an invoice", "description" : "Applies a customer's refundable credits to a specified invoice.
You can either specify the credit notes to be applied, or let Chargebee apply the available credit notes automatically.
status must be not_paid, payment_due, or posted.Invoice
amount_due decreases by the amount of credits applied.status:\npaid if the applied credits fully cover the amount due.Credit Notes
The credit note status:
refunded if the entire credit_note.amount_available is applied to the invoice.refund_due if only part of the credit_note.amount_available is applied.Before calling this API, make sure the following conditions are met:
customer.refundable_credits is non-zero.status is not_paid, payment_due, or posted.credit_note.customer_id matches the invoice.customer_id.The ID of the credit note to be applied to the invoice.
\nConstraints
credit_note.type must be refundable.credit_note.customer_id must always be the same as invoice.customer_id even if invoice.payment_owner is different.Default behavior
When the parameter is not passed, available refundable credits with the customer are applied to the invoice.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}" : { "get" : { "summary" : "Retrieve an invoice", "description" : "Retrieve the invoice for the specified invoice id.\n", "operationId" : "retrieve_an_invoice", "parameters" : [ { "name" : "line_items_limit", "in" : "query", "description" : "Specify the maximum number of line items to include in the response. \n**Note:**\n\n* Applicable only when Enterprise-scale Invoicing is enabled.\n* Enterprise-scale Invoicing is currently in **Private Beta** . Please reach out to [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support) to enable this feature.\n", "required" : false, "deprecated" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 100, "deprecated" : false, "maximum" : 300, "minimum" : 1, "example" : null } }, { "name" : "line_items_offset", "in" : "query", "description" : "Specify the starting point for retrieving line items. Use the value from the line_items_next_offset attribute of the previous retrieve API response.
Note:
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/create_for_charge_items_and_charges" : { "post" : { "summary" : "Create invoice for items and one-time charges", "description" : "Creates an invoice for charge-items and one-time charges. The item prices must belong to items of type charge.
One-time charges are represented in an invoice as line_items with entity_type adhoc.
Unique ID of the customer this invoice should be created for. Either this or subscription_id must be provided.
Note
The invoice is linked to the same business entity as this customer.
Unique ID of the subscription this invoice should be created for. Either this or customer_id must be provided.
Note
The invoice is linked to the same business entity as this subscription.
Set as true\nto remove the general note\nfrom this invoice.
The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.\ntaxes\nand\nline_item_taxes\nare computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe billing address associated with the bank account. The value is a JSON object with the following keys and their values:- first_name:(string, max chars=150) The first name of the contact.
last_name:(string, max chars=150) The last name of the contact.company_name:(string, max chars=250) The company name for the address.line1:(string, max chars=180) The first line of the address.line2:(string, max chars=180) The second line of the address.country:(string) The name of the country for the address.country_code:(string, max chars=50) The two-letter, ISO 3166 alpha-2 country code for the address.state:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, and India.state_code:(string, max chars=50) The ISO 3166-2 state/province code without the country prefix. This is supported for USA, Canada, and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).city:(string, max chars=50) The city name for the address.postal_code:(string, max chars=20) The postal or ZIP code for the address.phone:(string, max chars=50) The contact phone number for the address.email:(string, max chars=70) The contact email address for the address.ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nIf you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, then XI\n(the code for United Kingdom - Northern Ireland\n) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's devicecheckout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe price or per-unit-price of the item price. By default, it is the value set\nfor the item_price.\nThis is only applicable when the pricing_model\nof the item_price\nis flat_fee\nor per_unit.\nThe value depends on the type of currency\n.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Type of entity to which the note\nbelongs. To remove the general note, use the remove_general_note\nparameter.
Indicates that this line item is based on charge Item Price
\n* plan_item_price -Indicates that this line item is based on plan Item Price
\n* coupon -Entity that represents a coupon.
\n* addon -Entity that represents an addon.
\n* addon_item_price -Indicates that this line item is based on addon Item Price
\n* plan -Entity that represents a plan.
\n* customer -Entity that represents a customer.
\n* subscription -Entity that represents a subscription of customer.
", "enum" : [ "customer", "subscription", "coupon", "plan_item_price", "addon_item_price", "charge_item_price" ], "example" : null }, "example" : null }, "entity_id" : { "type" : "array", "description" : "Unique identifier of the [note](/docs/api/invoices/invoice-object#notes)\n.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null } }, "example" : null }, "tax_providers_fields" : { "type" : "object", "deprecated" : false, "description" : "Parameters for tax_providers_fields\n", "properties" : { "provider_name" : { "type" : "array", "description" : "Name of the tax provider currently supported.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "example" : null }, "field_id" : { "type" : "array", "description" : "Field id of the attribute which tax vendor has provided while getting onboarded with us.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "example" : null }, "field_value" : { "type" : "array", "description" : "The value of the corresponding tax field.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "example" : null } }, "example" : null }, "discounts" : { "type" : "object", "deprecated" : false, "description" : "Parameters for discounts\n", "properties" : { "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "quantity" : { "type" : "array", "description" : "Specifies the number of free units provided for the item, without affecting the total quantity sold\n", "items" : { "type" : "integer", "format" : "int32", "deprecated" : false, "minimum" : 1, "example" : null }, "example" : null }, "apply_on" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/update_details" : { "post" : { "summary" : "Update invoice details", "description" : "This API allows you to update the invoice Billing/Shipping address, VAT, custom fields, and PO number. During this operation if Billing Info (Billing Address, vat_number), Shipping info and PO number are not already present in the system the data will be added. If data is already present, the existing values will be replaced. If info is present in the system, but not passed as part of the request, the info will not be removed from the system. \n**Note:**\nIncase, tax is already applied will now vary due to address change, you cannot update the address. You cannot update the VAT Number if the billing address is not present in the API request.This will update the invoice only, it won't change the corresponding customer/subscription details.\n", "operationId" : "update_invoice_details", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "invoice-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/invoice-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "vat_number" : { "type" : "string", "deprecated" : false, "description" : "VAT/ Tax registration number of the customer. [Learn more](https://www.chargebee.com/docs/tax.html#capture-tax-registration-number)\n.\n", "maxLength" : 20, "example" : null }, "vat_number_prefix" : { "type" : "string", "deprecated" : false, "description" : "An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/record_payment" : { "post" : { "summary" : "Record an invoice payment", "description" : "Records an offline payment for an invoice.
Use this API to record payments that you receive outside Chargebee, such as bank transfers or checks, so that you can reconcile them against invoices.
status must be payment_due, posted, or not_paid.Invoice
amount_due on the invoice decreases by transaction[amount] when the transaction[status] is success.status changes to paid if the amount_due on the invoice becomes zero because of this payment. Otherwise, the status remains unchanged.Customer
If the recorded payment exceeds the invoice's amount_due, the excess is added to the customer's excess_payments balance.
Before calling this API, ensure the following:
status must be payment_due, posted, or not_paid.The payment transaction amount.
\nDefault value
amount_due on the invoice is considered as the payment amount.The payment method of this transaction
\n* cash -Cash
\n* grab_pay -Payments made via GrabPay
\n\n* kakao_pay -Payments made via Kakao Pay.
\n\n* swish -Payments made via Swish
\n\n* alipay -Payments made via Alipay.
\n\n* sofort -Sofort
\n* direct_debit -Direct Debit
\n* electronic_payment_standard -Electronic Payment Standard
\n* online_banking_poland -Online Banking Poland
\n\n* netbanking_emandates -netbanking_emandates
\n* klarna_pay_now -Klarna Pay Now
\n\n* naver_pay -Payments made via Naver Pay.
\n\n* twint -Payments made via Twint
\n\n* payconiq_by_bancontact -Payments made via Payconiq by Bancontact.
\n\n* pay_by_bank -Pay By Bank
\n* go_pay -Payments made via GoPay
\n\n* kbc_payment_button -KBC Payment Button
\n* paypal_express_checkout -Paypal Express Checkout
\n* automated_bank_transfer -Automated Bank Transfer
\n\n* venmo -Venmo
\n\n* bancontact -Bancontact
\n* after_pay -Payments made via Afterpay
\n\n* custom -Custom payment method.
\nPrerequisite
IDEAL
\n* check -Check
\n* upi -upi
\n* sepa_instant_transfer -Sepa Instant Transfer
\n\n* sepa_credit -SEPA Credit
\n* ach_credit -ACH Credit
\n* faster_payments -Faster Payments
\n\n* trustly -Trustly
\n* bank_transfer -Bank Transfer
\n* chargeback -Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.
Unionpay
\n* apple_pay -Apple Pay
\n* dotpay -Dotpay
\n* amazon_payments -Amazon Payments
\n* wechat_pay -Payments made via WeChat Pay.
\n\n* cash_app_pay -Payments made via Cash App Pay.
\n\n* google_pay -Google Pay
\n* payme -Payments made via PayMe
\n\n* pay_co -Payments made via PayCo
\n\n* card -Card
\n* other -Payment Methods other than the above types
\n* boleto -boleto
\n* giropay -giropay
\n* pay_to -PayTo
\n\n* stablecoin -Payments made via Stablecoin.
\n\n* revolut_pay -Payments made via Revolut Pay.
\n\n* pix -Pix
\n", "enum" : [ "cash", "check", "bank_transfer", "other", "custom" ], "example" : null }, "reference_number" : { "type" : "string", "deprecated" : false, "description" : "The reference number for this transaction. e.g check number in case of 'check' payments.\n", "maxLength" : 100, "example" : null }, "custom_payment_method_id" : { "type" : "string", "deprecated" : false, "description" : "A unique identifier for the custom payment method of this transaction.
\nPrerequisite
transaction[payment_method] is custom.The status of this transaction.
\n* failure -Transaction failed. Pass the transaction[error_code] and transaction[error_text] to identify the reason for failure.\nThe amount_due on the invoice or the customer's excess_payments balance is not affected when this status is set.
The transaction was successful.
\nImpacts
amount_due on the invoice is decreased by the transaction[amount].transaction[amount] is greater than the amount_due, the excess amount is added to the customer's excess_payments balance.Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.\nThe amount_due on the invoice or the customer's excess_payments balance is not affected when this status is set.
Transaction failed because of Gateway not accepting the connection.\nThe amount_due on the invoice or the customer's excess_payments balance is not affected when this status is set.
The transaction got voided or authorization expired at gateway.\nThe amount_due on the invoice or the customer's excess_payments balance is not affected when this status is set.
Indicates that a previously successful payment transaction has failed due to a late failure notification from the payment gateway. Common reasons include insufficient funds or a closed bank account.\nPass the transaction[error_code] and transaction[error_text] to identify the reason for failure.\nThe amount_due on the invoice or the customer's excess_payments balance is not affected when this status is set.
When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
The amount_due on the invoice or the customer's excess_payments balance is not affected when this status is set.
Error code for the transaction failure. This is typically set by the payment gateway when a transaction fails.
\nPrerequisite
transaction[status] is failure or late_failure.Error message for transaction failure. This is typically set by the payment gateway when a transaction fails.
\nPrerequisite
transaction[status] is failure or late_failure.Resource object representing invoice
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "invoice", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/delete" : { "post" : { "summary" : "Delete an invoice", "description" : "Deletes the specified invoice.
If the invoice was generated incorrectly, void it instead of deleting it. Voiding preserves the audit trail and allows for future reference and compliance without removing the original record.
linked_payments with txn_status as success or in_progress.amount_adjusted on the invoice should be zero.applied_credits with cn_status as refunded or refund_due.issued_credit_notes with cn_status as refunded or refund_due.linked_taxes_withheld.Invoices
deleted = true and can only be retrieved using the List invoices API by using the parameter include_deleted=true.invoice.first_invoice = true), the next invoice generated for the subscription or customer is marked as the first invoice.Subscription
Usages
Usage Events
usage_event resources.Integrations
Before calling this API, ensure the following:
linked_payments with txn_status as success or in_progress.applied_credits with cn_status as refunded or refund_dueissued_credit_notes with cn_status as refunded or refund_dueadjustment_credit_notes with cn_status as adjustedlinked_taxes_withheld.Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/import_invoice" : { "post" : { "summary" : "Import invoice", "description" : "Imports an invoice into Chargebee Billing.
Use this API to import invoices from your other billing or accounting system into Chargebee Billing. You can import both current-term and historical invoices.
Caution: Importing current-term invoices\nTo ensure accurate proration for any changes to the subscription in the current term, import only one current-term invoice. Chargebee considers only the first imported invoice for the current term when calculating proration. If you have multiple invoices for the current term in the source system, consolidate them into a single invoice before importing it into Chargebee.
RevenueStory
Accounting Integrations
discounts[entity_type][]discounts[amount][]discounts[line_item_id][i] if discounts[entity_type][i] is item_level_coupon or document_level_coupon.taxes[name][]taxes[rate][]line_items[tax*_name][]line_items[tax*_amount][]The invoice ID (also known as the invoice number).
\nConstraints
invoice.id.Identifier of the customer resource to which this invoice belongs.
\nRequired if
subscription_id is not provided.Constraints
subscription_id is provided:\ncustomer_id must match the subscription's customer.customer_id must match the gifter's customer.The ID of the subscription resource to which this invoice belongs.
\nRequired if
customer_id is not provided. ORline_items.subscription_id[] are not provided.An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Invoice total amount.
\nConstraints
line_items[amount][]) - (sum of discounts[amount][]) + (sum of taxes[amount][]) + round_off_amount.0 if hiding zero-value line items is enabled.Current status of this invoice.
\n* not_paid -Indicates the payment is not made and all attempts to collect is failed.
\n* voided -Indicates a voided invoice.
\n* paid -Indicates a paid invoice.
\n* posted -Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period.
\nPrerequisites
status can be posted only if payment terms for one-time invoices is enabled. Contact Support to enable this feature.The invoice is yet to be closed (sent for payment collection). An invoice is generated with this status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.\nThe invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.
Prerequisites
status can be pending only if Metered Billing is enabled for the site.Indicates the payment is not yet collected and is being retried as per retry settings.
", "enum" : [ "paid", "posted", "payment_due", "not_paid", "voided", "pending" ], "example" : null }, "voided_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp indicating the date \\& time this invoice got voided.\n", "example" : null }, "void_reason_code" : { "type" : "string", "deprecated" : false, "description" : "Reason code for voiding the invoice. Select from a list of reason codes set in the Chargebee app in **Settings \\> Configure Chargebee \\> Reason Codes \\> Invoices \\> Void invoice**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n", "maxLength" : 100, "example" : null }, "is_written_off" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "If is_written_off is true then the invoice is written off.\n", "example" : null }, "write_off_amount" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "Amount written off against this invoice.\nIf this value is not present then the due amount of the invoice will be written off.\n", "minimum" : 0, "example" : null }, "write_off_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The date on which the write_off invoice has occurred.\nThis is a mandatory field if is_written_off is true. The same date reflects on the created credit note.\n", "example" : null }, "due_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The due date of the invoice.
\nPrerequisites
due_date can be provided only if payment terms for one-time invoices is enabled. Contact Support to enable this feature.Required if
status is posted.Constraints
status is posted.status is payment_due.The number of days from invoice.date until payment for the invoice is due.
Prerequisites
net_term_days can be provided only if payment terms for one-time invoices is enabled. Contact Support to enable this feature.Required if
status is posted.Boolean indicating any advance charge is present in this invoice.
\nContraints
true only for a recurring invoice.The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
A unique identifier for the subscription resource to which this line item belongs.
\nConstraints
subscription_id is provided.line_items[] or none.current_term_end of the subscriptions provided must fall on the same calendar date according to the site's timezone.customer_id).Note
line_items.subscription_id[] are specified, this indicates a consolidated invoice.Description for this line item. Append - prorated charges to the description if the line item is prorated. This will prevent it from being considered for MRR calculations.
Quantity of the recurring item which is represented by this line item. For metered line items, this value is updated from usages once when the invoice is generated as pending and finally when the invoice is closed.\nQuantity of the recurring item which is represented by this line item.
The decimal representation of the unit amount of the line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the amount for the line_item\n, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
Specifies the modelled entity this line item is based on.
\n* addon -Indicates that this line item corresponds to an item of type addon.
Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the plan\nid
\n* plan_item_price -Indicates that this line item corresponds to an item_price of item_type plan.
Indicates that this line item corresponds to an item_price of item_type addon.
Indicates that this line item corresponds to an item_price of item_type charge.
Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
\n* plan_setup -Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the plan\nid
", "enum" : [ "adhoc", "plan_item_price", "addon_item_price", "charge_item_price" ], "example" : null }, "example" : null }, "entity_id" : { "type" : "array", "description" : "The ID of the entity that this line item corresponds to.
\nRequired if
entity_type is not adhoc.Constraints
entity_type is not adhoc:\nentity_id must be a valid ID for an entity of the same item_type as entity_type.item_price belonging to item with metered set to true are not supported.If id\nis not provided then our system will automatically generate a unique id.
This attribute helps type\nfield in the API, specifies how to reconcile offline payments, and generate payment_reference_number\non invoices based on country-specific rules. Setting the type\nfield generates payment_reference_number\nfor the respective country and includes them on the invoice for correct reconciliation.
The KID number (kundeidentifikasjon) in Norway is an abbreviation for "Customer identification". It is used to associate payments with the customer and invoice.
\n* fik -Denmark based number calculated using recursive MOD 10 algorithm.
\n* frn -The reference number printed on invoices in Finland is utilized by buyers for payment via bank transfer, facilitating the association of payments with invoices.
\n* ocr -A OCR-based payment, contains an OCR reference, which is used to identify the vendor and the purchase document in connection with a payment. Swedish reference number can contain customer ID and/or invoice number to identify customer and invoice.
", "enum" : [ "kid", "ocr", "frn", "fik", "swiss_reference" ], "example" : null }, "example" : null }, "number" : { "type" : "array", "description" : "If you have already generated a payment_reference_number\nin another system, you can provide it in this field. This number will then be made available to you both in PDF format and via the /api/v2/invoices/payment_reference_numbers\nAPI.
The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The unique id of the line item that this deduction is for.
\nRequired if
discounts[entity_type] is item_level_coupon or document_level_coupon.Constraints
line_items[id][].The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice.
\n* document_level_discount -The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
When the deduction is due to a coupon\n, then this is the id\nof the coupon. Is required when discounts[entity_type]\nis item_level_coupon\nor document_level_coupon\n.
Payment made for this invoice.
\nConstraints
payment[] array must not be sent when any of the following conditions are met:\nstatus is pending or voidedtotal is 0Mode of payment
\n* electronic_payment_standard -Electronic Payment Standard
\n* faster_payments -Faster Payments
\n\n* sepa_credit -SEPA Credit
\n* kbc_payment_button -KBC Payment Button
\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.
Google Pay
\n* check -Check
\n* giropay -giropay
\n* wechat_pay -Payments made via WeChat Pay.
\n\n* go_pay -Payments made via GoPay
\n\n* pay_to -PayTo
\n\n* grab_pay -Payments made via GrabPay
\n\n* naver_pay -Payments made via Naver Pay.
\n\n* pay_co -Payments made via PayCo
\n\n* alipay -Payments made via Alipay.
\n\n* pay_by_bank -Pay By Bank
\n* payme -Payments made via PayMe
\n\n* cash_app_pay -Payments made via Cash App Pay.
\n\n* swish -Payments made via Swish
\n\n* sofort -Sofort
\n* dotpay -Dotpay
\n* bank_transfer -Bank Transfer
\n* revolut_pay -Payments made via Revolut Pay.
\n\n* venmo -Venmo
\n\n* kakao_pay -Payments made via Kakao Pay.
\n\n* ach_credit -ACH Credit
\n* ideal -IDEAL
\n* after_pay -Payments made via Afterpay
\n\n* trustly -Trustly
\n* klarna_pay_now -Klarna Pay Now
\n\n* payconiq_by_bancontact -Payments made via Payconiq by Bancontact.
\n\n* stablecoin -Payments made via Stablecoin.
\n\n* custom -Custom
\n* upi -upi
\n* sepa_instant_transfer -Sepa Instant Transfer
\n\n* boleto -boleto
\n* apple_pay -Apple Pay
\n* amazon_payments -Amazon Payments
\n* direct_debit -Direct Debit
\n* bancontact -Bancontact
\n* twint -Payments made via Twint
\n\n* pix -Pix
\n\n* other -Payment Methods other than the above types
\n* cash -Cash
\n* unionpay -Unionpay
\n* automated_bank_transfer -Automated Bank Transfer
\n\n* paypal_express_checkout -Paypal Express Checkout
\n* netbanking_emandates -netbanking_emandates
\n* card -Card
", "enum" : [ "cash", "check", "bank_transfer", "other", "custom" ], "example" : null }, "example" : null }, "date" : { "type" : "array", "description" : "Payment date\n", "items" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "example" : null }, "reference_number" : { "type" : "array", "description" : "Reference number for this payment\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "minLength" : 1, "example" : null }, "example" : null } }, "required" : [ "amount", "payment_method" ], "example" : null }, "notes" : { "type" : "object", "deprecated" : false, "description" : "Parameters for notes\n", "properties" : { "entity_type" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "Type of entity to which the note belongs.\n\\* subscription -\n\nEntity that represents a subscription of customer.\n\\* plan_item_price -\n\nIndicates that this line item is based on plan Item Price\n\\* customer -\n\nEntity that represents a customer.\n\\* plan -\n\nEntity that represents a plan.\n\\* coupon -\n\nEntity that represents a coupon.\n\\* tax -\n\nThe note is configured as part of the [tax configuration](https://www.chargebee.com/docs/tax.html)\nin Chargebee Billing.\n\\* addon_item_price -\n\nIndicates that this line item is based on addon Item Price\n\\* charge_item_price -\n\nIndicates that this line item is based on charge Item Price\n\\* addon -\n\nEntity that represents an addon.\n", "enum" : [ "coupon", "plan_item_price", "addon_item_price", "charge_item_price" ], "example" : null }, "example" : null }, "entity_id" : { "type" : "array", "description" : "Id of the mentioned entity type.
\nConstraints
notes[] are not supported when status is pending.The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
Resource object representing invoice
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/resume_dunning" : { "post" : { "summary" : "Resume dunning for invoice", "description" : "Immediately resumes dunning for the specified invoice.
This operation is only permitted for an invoice with a status of payment_due and for which dunning was previously paused.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/record_tax_withheld" : { "post" : { "summary" : "Record tax withheld for an invoice", "description" : "Records tax_withheld by the customer against the invoice specified. This operation is allowed only when all of the following conditions are true:
invoice does not have a linked_taxes_withheld record associated with it already.invoice.amount_due is greater than zero.invoice.status is one of the following: payment_due, not_paid, or posted.The amount withheld by the customer as tax from the invoice. This must not exceed invoice.amount_due.\nThe unit depends on the type of currency.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/resend_einvoice" : { "post" : { "summary" : "Resend failed einvoice in invoices", "description" : "Resend failed einvoice of an invoice to the customer using this API.\n", "operationId" : "resend_failed_einvoice_in_invoices", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "invoice-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/invoice-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/remove_tax_withheld" : { "post" : { "summary" : "Remove tax withheld for an invoice", "description" : "Removes a linked_taxes_withheld record from the invoice specified. This operation is allowed only when all of the following conditions are true:
invoice.status is one of the following: payment_due, not_paid, or posted.adjustment_credit_notes associated with the invoice.issued_credit_notes associated with the invoice.An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_.\nFor example, tax_wh_16BdDXSlbu4uV1Ee6\n.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/payment_reference_numbers" : { "get" : { "summary" : "List payment reference numbers", "description" : "This API endpoint allows users to retrieve the payment reference numbers (PRNs) associated with an invoice. Only one PRN is allowed per payment type. You can use the invoice_id\nor the payment_reference_number[number]\nto retrieve the PRN.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Collects a specified amount of payment for an invoice, via a specified online payment method.
When there is no payment method available, and if you wish to record an offline payment, use the Record an offline payment API instead.
status must be payment_due, posted, or not_paid.channel must not be app_store or play_store.amount_to_collect must be greater than 0.payment_source must be associated with the customer.Invoice
status changes to paid if the amount_due on the invoice becomes zero because of this payment. Otherwise, the status remains unchanged.Payment Schedules
If a payment_schedule exists for the invoice, then the status of the appropriate schedule_entries[].status is updated to paid.
Amount to be collected.
\nConstraints
invoice.amount_to_collect or the transaction.amount if authorization_transaction_id is passed, whichever is lesser.Default value
invoice.amount_to_collect is assumed.The id of the transaction that is used to authorize the payment. (The transaction's type must be authorization.)
Required if
payment_source_id is not passed.Prerequisites
transaction.fraud_flag must be safe.Constraints
The id of a valid payment_source associated with the customer.
Required if
authorization_transaction_id is not passed.Resource object representing invoice
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "invoice", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/sync_usages" : { "post" : { "summary" : "Sync usages", "description" : "Updates the quantity for metered line_items of an invoice to reflect the latest usage data.\nNote: This operation is done automatically while closing the invoice.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/refund" : { "post" : { "summary" : "Refund an invoice", "description" : "Refunds online payments or online refundable credit notes applied to an invoice.
If multiple transactions or credit note allocations are associated with the invoice, the refund can be processed only for one transaction or allocation at a time. The refund amount is returned to the customer through the payment_source associated with the transaction.
For recording offline refunds, including those for linked_taxes_withheld, use the Record refund for an invoice API.
linked_payments with a status of in-progress.Before calling this API, ensure the following:
linked_payments[].amount for online payments + applied_credits[].applied_amount - issued_credit_notes[].cn_totallinked_payments with a status of in-progress.The amount to be refunded.
\nConstraints
linked_taxes_withheld, cannot be refunded via this operation. Use the Record refund for an invoice API instead.Default behavior
Resource object representing invoice
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "invoice", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/record_refund" : { "post" : { "summary" : "Record refund for an invoice", "description" : "Record a full or partial offline refund for an invoice.
Use this API to record refunds processed outside Chargebee (for example, directly through a payment gateway or via offline methods such as bank transfers or checks) so you can reconcile them in Chargebee.
Important: This API does not process actual refunds for online payments or return money to customers through the payment gateway. To process refunds for online payments and return money to customers, use the Refund an invoice API instead.
The invoice must have a refundable amount. (See Implementation Notes for details.)
Credit note
Chargebee creates a refundable credit note with status set to refunded.
Transactions
Chargebee records the refunds by creating transactions of type refund and links them to the credit note. The refund transactions are recorded in the following order:
linked_payments for offline transactions. This is recorded as linked_refunds[] in the credit note.linked_taxes_withheld (if available). This is recorded as linked_tax_withheld_refunds[] in the credit note.linked_payments for online transactions (after offline payments and taxes withheld are exhausted). This is recorded as linked_refunds[] in the credit note.Example
Consider an invoice with the following payments and tax withheld:
When you record a refund of $40, Chargebee allocates the refund as follows:
Before calling this API, perform the following checks:
transaction[date] is on or after the invoice date and not in the future.transaction[amount] parameter to specify the refund amount. If you omit this parameter, the system records the entire refundable amount as refunded.credit_note[create_reason_code] parameter with a value from the configured list of codes.The amount to be refunded (for online payments) or recorded as refunded (for offline payments). If not specified, the entire refundable amount for this invoice is refunded. The refundable amount is the total amount paid (and not already refunded) for the invoice.
\nNote:\nAny linked_taxes_withheld\nassociated with the invoice can also be recorded as refunded via this operation.
The payment method of this transaction
\n* cash -Cash
\n* grab_pay -Payments made via GrabPay
\n\n* kakao_pay -Payments made via Kakao Pay.
\n\n* swish -Payments made via Swish
\n\n* alipay -Payments made via Alipay.
\n\n* sofort -Sofort
\n* direct_debit -Direct Debit
\n* electronic_payment_standard -Electronic Payment Standard
\n* netbanking_emandates -netbanking_emandates
\n* klarna_pay_now -Klarna Pay Now
\n\n* naver_pay -Payments made via Naver Pay.
\n\n* twint -Payments made via Twint
\n\n* payconiq_by_bancontact -Payments made via Payconiq by Bancontact.
\n\n* pay_by_bank -Pay By Bank
\n* go_pay -Payments made via GoPay
\n\n* kbc_payment_button -KBC Payment Button
\n* paypal_express_checkout -Paypal Express Checkout
\n* automated_bank_transfer -Automated Bank Transfer
\n\n* venmo -Venmo
\n\n* bancontact -Bancontact
\n* after_pay -Payments made via Afterpay
\n\n* custom -Custom
\n* ideal -IDEAL
\n* check -Check
\n* upi -upi
\n* sepa_instant_transfer -Sepa Instant Transfer
\n\n* sepa_credit -SEPA Credit
\n* ach_credit -ACH Credit
\n* faster_payments -Faster Payments
\n\n* trustly -Trustly
\n* bank_transfer -Bank Transfer
\n* chargeback -Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.
Unionpay
\n* apple_pay -Apple Pay
\n* dotpay -Dotpay
\n* amazon_payments -Amazon Payments
\n* wechat_pay -Payments made via WeChat Pay.
\n\n* cash_app_pay -Payments made via Cash App Pay.
\n\n* google_pay -Google Pay
\n* payme -Payments made via PayMe
\n\n* pay_co -Payments made via PayCo
\n\n* card -Card
\n* other -Payment Methods other than the above types
\n* boleto -boleto
\n* giropay -giropay
\n* pay_to -PayTo
\n\n* stablecoin -Payments made via Stablecoin.
\n\n* revolut_pay -Payments made via Revolut Pay.
\n\n* pix -Pix
\n", "enum" : [ "cash", "check", "chargeback", "bank_transfer", "other", "custom" ], "example" : null }, "reference_number" : { "type" : "string", "deprecated" : false, "description" : "The reference number for this transaction. For example, the check number when payment_method\n= check\n.
Resource object representing invoice
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/pdf" : { "post" : { "summary" : "Retrieve Invoice as PDF", "description" : "Gets the invoice as PDF. The returned URL is secure and allows download. The URL will expire in 60 minutes.\n\n#### Related Tutorial\n\n* [Check out customer portal tutorial on how to download invoice as PDF.](https://www.chargebee.com/tutorials/customer-portal-sample.html#downloading_invoices_as_pdf)\n", "operationId" : "retrieve_invoice_as_pdf", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "invoice-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/invoice-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "disposition_type" : { "type" : "string", "default" : "attachment", "deprecated" : false, "description" : "Determines the pdf should be rendered as inline or attachment in the browser.\n\\* attachment -\n\nPDF is rendered as attachment in the browser\n\\* inline -\n\nPDF is rendered as inline in the browser\n", "enum" : [ "attachment", "inline" ], "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "download" : { "$ref" : "#/components/schemas/Download", "description" : "Resource object representing download
" } }, "required" : [ "download" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/download_einvoice" : { "get" : { "summary" : "Download e-invoice", "description" : "Download the e-invoice in both XML and PDF formats. The response consists of a download object for each format. The XML format follows the structure as per Peppol BIS Billing v3.0.
Note
status is success.cbc:EmbeddedDocumentBinaryObject, which is the Base64-encoded version of the PDF.Resource object representing download
", "items" : { "$ref" : "#/components/schemas/Download", "description" : "Resource object representing download" }, "example" : null } }, "required" : [ "downloads" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/record_refund" : { "post" : { "summary" : "Record refund for a credit note", "description" : "Records a refund for a refundable credit note.
This API does not process an actual refund for online payments by returning money to customers.
Use this API to record refunds processed outside Chargebee (for example, directly through a payment gateway or via offline methods such as bank transfers or checks) so you can reconcile them in Chargebee.
To process refunds via Chargebee for online payments and automatically return money to customers, use the Refund a credit note API instead.
Transactions
Chargebee records the refunds by creating transactions of type refund and links them to the credit note. The refund transactions are recorded in the following order:
linked_payments of the invoice associated with the credit note. This is recorded as linked_refunds[] in the credit note.linked_taxes_withheld (if available). This is recorded as linked_tax_withheld_refunds[] in the credit note.Before using this API, ensure:
type is refundable.status is refund_due.refund_reason_code parameter with a value from the configured list of codes.The amount to be recorded as refunded. If not specified, the entire refundable amount\nfor this credit_note\nis assumed.
The payment method of this transaction
\n* cash -Cash
\n* grab_pay -Payments made via GrabPay
\n\n* kakao_pay -Payments made via Kakao Pay.
\n\n* swish -Payments made via Swish
\n\n* alipay -Payments made via Alipay.
\n\n* sofort -Sofort
\n* direct_debit -Direct Debit
\n* electronic_payment_standard -Electronic Payment Standard
\n* netbanking_emandates -netbanking_emandates
\n* klarna_pay_now -Klarna Pay Now
\n\n* naver_pay -Payments made via Naver Pay.
\n\n* twint -Payments made via Twint
\n\n* payconiq_by_bancontact -Payments made via Payconiq by Bancontact.
\n\n* pay_by_bank -Pay By Bank
\n* go_pay -Payments made via GoPay
\n\n* kbc_payment_button -KBC Payment Button
\n* paypal_express_checkout -Paypal Express Checkout
\n* automated_bank_transfer -Automated Bank Transfer
\n\n* venmo -Venmo
\n\n* bancontact -Bancontact
\n* after_pay -Payments made via Afterpay
\n\n* custom -Custom
\n* ideal -IDEAL
\n* check -Check
\n* upi -upi
\n* sepa_instant_transfer -Sepa Instant Transfer
\n\n* sepa_credit -SEPA Credit
\n* ach_credit -ACH Credit
\n* faster_payments -Faster Payments
\n\n* trustly -Trustly
\n* bank_transfer -Bank Transfer
\n* chargeback -Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.
Unionpay
\n* apple_pay -Apple Pay
\n* dotpay -Dotpay
\n* amazon_payments -Amazon Payments
\n* wechat_pay -Payments made via WeChat Pay.
\n\n* cash_app_pay -Payments made via Cash App Pay.
\n\n* google_pay -Google Pay
\n* payme -Payments made via PayMe
\n\n* pay_co -Payments made via PayCo
\n\n* card -Card
\n* other -Payment Methods other than the above types
\n* boleto -boleto
\n* giropay -giropay
\n* pay_to -PayTo
\n\n* stablecoin -Payments made via Stablecoin.
\n\n* revolut_pay -Payments made via Revolut Pay.
\n\n* pix -Pix
\n", "enum" : [ "cash", "check", "chargeback", "bank_transfer", "other", "custom" ], "example" : null }, "reference_number" : { "type" : "string", "deprecated" : false, "description" : "The reference number for this transaction. For example, the check number when payment_method\n= check\n.
Resource object representing credit_note
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/import_credit_note" : { "post" : { "summary" : "Import credit note", "description" : "Imports a credit note into Chargebee Billing. This endpoint allows you to import a credit note from external systems, such as accounting software, into Chargebee.
Use this operation during data migration or reconciliation to ensure historical credits are represented in the system. The credit note is linked to a reference invoice and can be allocated to other invoices or recorded as refunded to the customer.
Credit Note
The credit note's billing_address, shipping_address, and vat_number are copied from the reference invoice.
Invoices
allocations[] are provided, then for each allocated invoice:\namount_due decreases by the allocated amountstatus changes to paid if the amount_due becomes zeroTransactions
If linked_refunds[] are provided, then for each refund provided, a transaction of type refund is created with status set to success.
The unique identifier of the customer for whom the credit note is created.
\nRequired if
subscription_id is not provided.Constraints
reference_invoice_id.The unique identifier of the subscription for which this credit note is created.
\nRequired if
customer_id is not provided.Constraints
reference_invoice_id.line_items[subscription_id][] is provided.The credit note type. Determines how the credit note can be used. Learn more about credit note types.
\n* refundable -Refundable credit note.
\n* store -Store credit note.
\nConstraints
type value store is not supported for this API operation.Adjustment credit note.
", "enum" : [ "adjustment", "refundable", "store" ], "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "The currency code (ISO 4217 format) for the credit note.
\nRequired if
customer_id is provided.The date when the credit note was issued.
\nConstraints
date of the reference invoice.The status of the credit note. Determines the current state of the credit note and how it can be used.
\nDefault value
adjusted if type is adjustment.type is refundable:\nrefunded if the credit note total is equal to the sum of linked_refunds[amount][] plus the sum of allocations[allocated_amount][].refund_due otherwise.The credits are yet to be used or have been partially used.
\nConstraints
type is refundable.total must be greater than the sum of linked_refunds[amount][] plus the sum of allocations[allocated_amount][].The entire credit note amount has been used (either allocated to invoices or refunded).
\nConstraints
type is refundable.linked_refunds[] and/or allocations[] to be provided.linked_refunds[amount][] plus the sum of allocations[allocated_amount][] must equal the credit note total.The credit note has been cancelled.
\nConstraints
linked_refunds[] and allocations[] must not be provided when status is voided.The credit note has been adjusted against an invoice.
\nConstraints
type is adjustment.allocations[] to be provided and linked_refunds[] must not be provided.The total amount of the credit note.
\nConstraints
type = refundable), this must be less than or equal to the reference invoice's refundable amount.type = adjustment), this must be less than or equal to the reference invoice's amount_to_collect.The timestamp when this credit note was fully used (refunded or allocated). This field is automatically set when the credit note status becomes refunded or adjusted.
The timestamp indicating when this credit note was voided.
\nConstraints
status must be voided.Default value
date.The rounded-off amount for the credit note. For example, if the credit note amount is $99.99 and it is rounded off to $100.00, then $0.01 is the round_off_amount.
Constraints
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The unique identifier of the line item from the reference invoice that this credit note line item reverses.
\nConstraints
line_item.id must exist in the reference invoice. Contact Support to enable this feature.The unique identifier of the subscription this line item belongs to.
\nConstraints
The unit amount of the line item.
\nRequired if
flat_fee, per_unit, or volume.Constraints
unit_amount of the line item in the reference invoice. Contact Support to enable this feature.The quantity of the line item.
\nRequired if
per_unit or volume.Constraints
The total amount of this line item.
\nRequired if
stairstep or tiered.line_items[unit_amount] is not provided.Constraints
line_items[unit_amount] and line_items[quantity], when both are provided.amount of the line item in the reference invoice. Contact Support to enable this feature.The decimal representation of the unit amount of the line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the amount for the line_item\n, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
First tax name.
\nRequired if
line_items[tax1_amount] is provided.Constraints
taxes[name].First tax amount.
\nRequired if
line_items[tax1_name] is provided.Second tax name.
\nRequired if
line_items[tax2_amount] is provided.Constraints
taxes[name].Second tax amount.
\nRequired if
line_items[tax2_name] is provided.Third tax name.
\nRequired if
line_items[tax3_amount] is provided.Constraints
taxes[name].Third tax amount.
\nRequired if
line_items[tax3_name] is provided.Fourth tax name.
\nRequired if
line_items[tax4_amount] is provided.Constraints
taxes[name].Fourth tax amount.
\nRequired if
line_items[tax4_name] is provided.Fifth tax name.
\nRequired if
line_items[tax5_amount] is provided.Constraints
taxes[name].Fifth tax amount.
\nRequired if
line_items[tax5_name] is provided.Sixth tax name.
\nRequired if
line_items[tax6_amount] is provided.Constraints
taxes[name].Sixth tax amount.
\nRequired if
line_items[tax6_name] is provided.Seventh tax name.
\nRequired if
line_items[tax7_amount] is provided.Constraints
taxes[name].Seventh tax amount.
\nRequired if
line_items[tax7_name] is provided.Eighth tax name.
\nRequired if
line_items[tax8_amount] is provided.Constraints
taxes[name].Eighth tax amount.
\nRequired if
line_items[tax8_name] is provided.Ninth tax name.
\nRequired if
line_items[tax9_amount] is provided.Constraints
taxes[name].Ninth tax amount.
\nRequired if
line_items[tax9_name] is provided.Tenth tax name.
\nRequired if
line_items[tax10_amount] is provided.Constraints
taxes[name].Tenth tax amount.
\nRequired if
line_items[tax10_name] is provided.Parameters for line item tiers. Used to specify tiered pricing details for line items with tiered, volume, or stairstep pricing models.
The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The unique identifier of the line item that this deduction is for. This must match the line_items[id] of the line item to which the discount is applied.
Required if
discounts[entity_type] is item_level_coupon or item_level_discount.Constraints
id specified (i.e., line_items[id] must be provided for the line item).The type of deduction and the amount to which it is applied. Determines whether the discount is applied at the document level or item level, and whether it's a coupon, discount, or promotional credit.
\n* document_level_coupon -The deduction is due to a coupon applied at the document level.
\nConstraints
discounts[entity_id] to be provided to identify the coupon.The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied at the line item level.
\nConstraints
discounts[line_item_id] is required and must match the line_items[id] of the line item.discounts[entity_id] to be provided to identify the coupon.The deduction is due to a discount applied at the line item level.
\nConstraints
discounts[line_item_id] is required and must match the line_items[id] of the line item.discounts[entity_id] must not be provided.The deduction is due to a promotional credit applied.
\nConstraints
discounts[entity_id] must not be provided.The deduction is due to a discount applied at the document level.
\nConstraints
discounts[entity_id] must not be provided.The unique identifier of the coupon.
\nRequired if
discounts[entity_type] is item_level_coupon or document_level_coupon.Constraints
discounts[entity_type] is document_level_discount or item_level_discount.item_level_coupon, the coupon must be applicable to the plan or addon associated with the line item.document_level_coupon, the coupon must have apply_on set to invoice_amount.Parameters for document-level taxes. Used to specify tax information at the credit note level.
\nPrerequisite
taxes[] must not be provided if the reference invoice has all line items exempted from tax for any one of the following reasons: customer_exempt, reverse_charge, or export (i.e. if all line_items[].tax_exempt_reason on the reference invoice are set to customer_exempt, reverse_charge, or export).The name of the tax applied.
\nConstraints
line_items[tax*_name].The rate of tax.
\nNote
name and other tax metadata. It is not used to calculate or validate the tax amount.The total tax amount for this credit note.
\nConstraints
line_items[tax*_amount][]) for the given combination of name, rate, juris_type, juris_name, and juris_code.Parameters for credit allocations. Used to specify how the credit note amount is allocated to invoices.
\nRequired if
status is adjusted.Constraints
type = adjustment), only one allocation is allowed.status is voided.The amount allocated from this credit note to the specified invoice.
\nConstraints
allocated_amount[] plus the sum of linked_refunds[amount][] must not exceed the total.The timestamp when the allocation occurred.
\nConstraints
date.Default value
date.Parameters for linked refunds. Used to record refund transactions associated with this credit note.
\nRequired if
status is refunded and no allocations[] are provided.Constraints
status is adjusted or voided.The amount of this refund transaction.
\nConstraints
linked_refunds[amount][] plus the sum of allocations[allocated_amount][] must not exceed the total of the credit note.The payment method used for the refund.
\n* twint -Payments made via Twint
\n\n* amazon_payments -Amazon Payments
\n* payme -Payments made via PayMe
\n\n* sepa_credit -SEPA Credit
\n* sofort -Sofort
\n* electronic_payment_standard -Electronic Payment Standard
\n* alipay -Payments made via Alipay.
\n\n* automated_bank_transfer -Automated Bank Transfer
\n\n* direct_debit -Direct Debit
\n* kbc_payment_button -KBC Payment Button
\n* trustly -Trustly
\n* pay_co -Payments made via PayCo
\n\n* kakao_pay -Payments made via Kakao Pay.
\n\n* naver_pay -Payments made via Naver Pay.
\n\n* giropay -giropay
\n* dotpay -Dotpay
\n* bancontact -Bancontact
\n* go_pay -Payments made via GoPay
\n\n* grab_pay -Payments made via GrabPay
\n\n* other -Payment Methods other than the above types
\n* revolut_pay -Payments made via Revolut Pay.
\n\n* payconiq_by_bancontact -Payments made via Payconiq by Bancontact.
\n\n* swish -Payments made via Swish
\n\n* upi -upi
\n* wechat_pay -Payments made via WeChat Pay.
\n\n* netbanking_emandates -netbanking_emandates
\n* venmo -Venmo
\n\n* faster_payments -Faster Payments
\n\n* klarna_pay_now -Klarna Pay Now
\n\n* pay_by_bank -Pay By Bank
\n* unionpay -Unionpay
\n* ideal -IDEAL
\n* cash -Cash
\n* stablecoin -Payments made via Stablecoin.
\n\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.
boleto
\n* custom -Custom
\n* google_pay -Google Pay
\n* paypal_express_checkout -Paypal Express Checkout
\n* pay_to -PayTo
\n\n* card -Card
\n* cash_app_pay -Payments made via Cash App Pay.
\n\n* after_pay -Payments made via Afterpay
\n\n* bank_transfer -Bank Transfer
\n* apple_pay -Apple Pay
\n* sepa_instant_transfer -Sepa Instant Transfer
\n\n* check -Check
\n* pix -Pix
\n\n* ach_credit -ACH Credit
", "enum" : [ "cash", "check", "bank_transfer", "other", "custom" ], "example" : null }, "example" : null }, "date" : { "type" : "array", "description" : "The date when the refund occurred. \n**Constraints**\n\n* Must be a date in the past.\n", "items" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "example" : null }, "reference_number" : { "type" : "array", "description" : "Reference number for this refund.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "minLength" : 1, "example" : null }, "example" : null } }, "required" : [ "amount", "date", "payment_method" ], "example" : null } }, "required" : [ "create_reason_code", "date", "id", "reference_invoice_id", "type" ], "example" : null }, "encoding" : { "allocations" : { "style" : "deepObject", "explode" : true }, "discounts" : { "style" : "deepObject", "explode" : true }, "line_item_tiers" : { "style" : "deepObject", "explode" : true }, "line_items" : { "style" : "deepObject", "explode" : true }, "linked_refunds" : { "style" : "deepObject", "explode" : true }, "taxes" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/delete" : { "post" : { "summary" : "Delete a credit Note", "description" : "This API [deletes a credit note.](https://www.chargebee.com/docs/credit-notes.html#voiding-or-deleting-a-credit-note) A credit note once deleted, is deleted permanently. You cannot delete a credit which has already been deleted or refunded. If you try to delete a refunded or deleted credit note, an error message will be displayed.\n", "operationId" : "delete_a_credit_note", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "credit-note-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/credit-note-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "comment" : { "type" : "string", "deprecated" : false, "description" : "Reason for deleting this transaction. This comment will be added to the associated entity.\n", "maxLength" : 300, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/pdf" : { "post" : { "summary" : "Retrieve credit note as PDF", "description" : "Gets the credit note as PDF. The returned URL is secure and allows download. The URL will expire in 60 minutes.\n", "operationId" : "retrieve_credit_note_as_pdf", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "credit-note-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/credit-note-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "disposition_type" : { "type" : "string", "default" : "attachment", "deprecated" : false, "description" : "Determines the pdf should be rendered as inline or attachment in the browser.\n\\* attachment -\n\nPDF is rendered as attachment in the browser\n\\* inline -\n\nPDF is rendered as inline in the browser\n", "enum" : [ "attachment", "inline" ], "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "download" : { "$ref" : "#/components/schemas/Download", "description" : "Resource object representing download
" } }, "required" : [ "download" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/send_einvoice" : { "post" : { "summary" : "Send an einvoice for credit notes", "description" : "This endpoint is used to send an e-invoice for invoice.\nTo support cases like TDS and invoice edits, we need to stop auto e-invoice sending and be able to send e-invoices manually.\nThis endpoint schedules e-invoices manually. This operation is not allowed when any of the following condition matches:
If e-invoicing is not enabled at the site and customer level.
\nIf there is an e-invoice generated already for the invoice.
\nIf the Use automatic e-invoicing option is selected.
\nIf there are no generated e-invoices with the failed or skipped status.
If the invoice status is voided or pending.
Resource object representing credit_note
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/void" : { "post" : { "summary" : "Void a credit note", "description" : "Void or invalidate the specified credit note.
Use this operation for incorrectly generated credit notes, such as those with wrong details or created by mistake. This is a preferred method over deleting the credit note, as it preserves the audit trail, allowing for future reference and compliance without removing the original record.
status must not be refunded or voided.type refundable, you must remove any allocations or linked refunds before voiding it. Note that only offline refunds can be removed; online refunds cannot.See Implementation Notes for more details.
Invoices
If the credit note type is adjustment, the associated invoice status changes to not_paid, and the amount_due on the invoice increases by the amount that was allocated via the credit note.
Before calling this API, ensure the following:
status must not be refunded or voided.type refundable:\nResource object representing credit_note
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/refund" : { "post" : { "summary" : "Refund a credit note", "description" : "Refunds a specified amount from a refundable credit note back to the customer's payment source.
This operation supports only refunds against online payments. The refund amount is returned to the customer through the payment_source associated with the transaction. If multiple transactions are associated with the credit note, call this API once for each transaction.
To record offline refunds, including those for linked_taxes_withheld, use the Record refund for a credit note API.
type is refundable.status is refund_due.amount_available greater than 0.amount_available is from online payments.Credit note
amount_available is reduced by the refunded amount.status is updated to refunded if the refunded amount is equal to the credit note's amount_available.linked_refunds is updated with the details of the refund transaction.Transaction
Chargebee creates a transaction of type refund and links it to the credit note under credit_note.linked_refunds.
Before you call this API, make sure the following conditions are met:
The amount to be refunded.
\nConstraints
linked_taxes_withheld, cannot be refunded via this operation. Use the Record refund for a credit note API instead.Default behavior
amount_available for this credit note is implied.Resource object representing credit_note
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "credit_note", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes" : { "get" : { "summary" : "List credit notes", "description" : "Lists all the Credit Notes.\n", "operationId" : "list_credit_notes", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
The status of processing the e-invoice. To obtain detailed information about the current status\n, see message\n.
entity_identifier is not registered on the e-invoicing network.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.",
"enum" : [ "scheduled", "skipped", "in_progress", "success", "failed", "registered", "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `scheduled` - Sending the e-invoice to the customer has been scheduled.\n* `skipped` - The e-invoice was not sent. This could be due to missing information or because the entity_identifier is not registered on the e-invoicing network.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.",
"enum" : [ "scheduled", "skipped", "in_progress", "success", "failed", "registered", "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `scheduled` - Sending the e-invoice to the customer has been scheduled.\n* `skipped` - The e-invoice was not sent. This could be due to missing information or because the entity_identifier is not registered on the e-invoicing network.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.",
"enum" : [ "scheduled", "skipped", "in_progress", "success", "failed", "registered", "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ],
"pattern" : "^\\[(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid)(,(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `scheduled` - Sending the e-invoice to the customer has been scheduled.\n* `skipped` - The e-invoice was not sent. This could be due to missing information or because the entity_identifier is not registered on the e-invoicing network.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `rejected` - The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.",
"enum" : [ "scheduled", "skipped", "in_progress", "success", "failed", "registered", "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ],
"pattern" : "^\\[(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid)(,(scheduled|skipped|in_progress|success|failed|registered|accepted|rejected|message_acknowledgement|in_process|under_query|conditionally_accepted|paid))*\\]$",
"example" : null
}
}
}
},
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"credit_note" : {
"$ref" : "#/components/schemas/CreditNote",
"description" : "Resource object representing credit_note"
}
},
"required" : [ "credit_note" ],
"example" : null
},
"example" : null
},
"next_offset" : {
"type" : "string",
"description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.",
"maxLength" : 1000,
"example" : null
}
},
"required" : [ "list" ],
"example" : null
}
}
}
},
"400" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/400"
}
}
}
},
"401" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/401"
}
}
}
},
"403" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/403"
}
}
}
},
"404" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/404"
}
}
}
},
"405" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/405"
}
}
}
},
"409" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/409"
}
}
}
},
"422" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/422"
}
}
}
},
"429" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/429"
}
}
}
},
"500" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/500"
}
}
}
},
"503" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/503"
}
}
}
}
},
"deprecated" : false,
"security" : [ {
"BasicAuth" : [ ]
} ]
},
"post" : {
"summary" : "Create credit note",
"description" : "Creates a credit note for the specified invoice.
Invoice
Credit note
type is created.type is adjustment:\ntotal and amount_allocated are set to the adjusted amount.status is set to adjusted.type is refundable or store:\ntotal and amount_available are set to the refundable amount.status is set to refund_due.taxes[].amount and line_item_taxes[].tax_amount are set to the corresponding values on the invoice, prorated by the ratio of credit_note.total to invoice.total.The identifier of the invoice against which this credit note is issued.
\nRequired when
type is adjustment or store.Note\nWhen not provided and type is refundable, then customer_id must be provided because this creates a standalone credit note.
The identifier of the customer for whom this credit note is issued.
\nRequired when
type is refundable and reference_invoice_id is not provided. This creates a standalone credit note.The total credit note amount.
\nConstraints
total or line_items parameter.type is adjustment, total must not exceed the amount due on the invoice minus the total amount of any transactions in progress for the invoice. Calculate this as invoice.amount_due minus the sum of invoice.linked_payments[i].amount where invoice.linked_payments[i].txn_status is in_progress.type is refundable or store:\nreference_invoice_id is provided, total must not exceed the refundable amount on the invoice. Calculate the refundable amount as the sum of:\nlinked_payments[i].amount where linked_payments[i].txn_status is successapplied_credits[i].applied_amount where applied_credits[i].status is not voidedlinked_taxes_withheld[].amountissued_credit_notes[i].cn_total where issued_credit_notes[i].status is not voidedreference_invoice_id is not provided, there is no limit on the total because this creates a standalone credit note.The type of credit note to create.
\nPrerequisites
type is adjustment, the invoice.status must be payment_due, posted or not_paid.type is refundable or store, the invoice.status must be paid, payment_due, posted, or not_paid.Creates a refundable credit note.
\nPrerequisites
invoice.status must be paid, payment_due, posted, or not_paid.Creates a store credit note.
\nPrerequisites
invoice.status must be paid, payment_due, posted, or not_paid.Creates an adjustment credit note.
\nPrerequisites
invoice.status must be payment_due, posted or not_paid.The date on which the credit note is issued.
\nConstraints
invoice.date and cannot be a future date.The decimal representation of the unit amount of the line_item.\nThe value is in major units of the currency. Applicable for the line_item when the pricing_model\nis flat_fee\n, per_unit\nor volume.\nCan be provided only when multi-decimal pricing\nis enabled.
The decimal representation of the quantity of the line_item.\nApplicable for the line_item\nwhen the pricing_model\nis per_unit\nand volume.\nCan be provided only when multi-decimal pricing\nis enabled.
Resource object representing credit_note
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/download_einvoice" : { "get" : { "summary" : "Download e-invoice for credit note", "description" : "Download the e-invoice for the credit note in both XML and PDF formats. The response consists of a download object for each format. The XML format follows the structure as per Peppol BIS Billing v3.0.
Note
status is success or registered.cbc:EmbeddedDocumentBinaryObject, which is the Base64-encoded version of the PDF.Resource object representing download
", "items" : { "$ref" : "#/components/schemas/Download", "description" : "Resource object representing download" }, "example" : null } }, "required" : [ "downloads" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/resend_einvoice" : { "post" : { "summary" : "Resend failed einvoice in credit notes", "description" : "Resend failed einvoice in credit notes.\n", "operationId" : "resend_failed_einvoice_in_credit_notes", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "credit-note-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/credit-note-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/remove_tax_withheld_refund" : { "post" : { "summary" : "Remove tax withheld refunds from a credit note", "description" : "Removes a linked_tax_withheld_refunds\nrecord from the credit_note\n.
An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_.\nFor example, tax_wh_16BdDXSlbu4uV1Ee6\n.
Resource object representing credit_note
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}" : { "get" : { "summary" : "Retrieve a credit note", "description" : "Retrieves the Credit Note identified by the specified Credit Note number.\n", "operationId" : "retrieve_a_credit_note", "parameters" : [ { "name" : "line_items_limit", "in" : "query", "description" : "Specify the maximum number of line items to include in the response. \n**Note:**\n\n* Applicable only when Enterprise-scale Invoicing is enabled.\n* Enterprise-scale Invoicing is currently in **Private Beta** . Please reach out to [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support) to enable this feature.\n", "required" : false, "deprecated" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 100, "deprecated" : false, "maximum" : 300, "minimum" : 1, "example" : null } }, { "name" : "line_items_offset", "in" : "query", "description" : "Specify the starting point for retrieving line items. Use the value from the line_items_next_offset attribute of the previous retrieve API response.
Note:
Resource object representing credit_note
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/unbilled_charges/{unbilled-charge-id}/delete" : { "post" : { "summary" : "Delete an unbilled charge", "description" : "Use this API to delete an unbilled charge by specifying the id of the charge.\n", "operationId" : "delete_an_unbilled_charge", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "unbilled-charge-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/unbilled-charge-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "unbilled_charge" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge
" } }, "required" : [ "unbilled_charge" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/unbilled_charges/invoice_now_estimate" : { "post" : { "summary" : "Create an estimate for unbilled charges", "description" : "This is similar to the \"Create an invoice for unbilled charges\" API but no invoice will be created, only an estimate for this operation is created.\n\nIn the estimate response,\n\n* **estimate.invoice_estimates** is an array of **estimate.invoice_estimate**. This has the details of the invoices that will be generated now.\n\n**Note:**\n\n* This API when invoked does not perform the actual operation. It just generates an estimate.\n* Both *subscription_id* and *customer_id* parameters should not be given at the same time.\n", "operationId" : "create_an_estimate_for_unbilled_charges", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "subscription_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the subscription for which this estimate needs to be created. Should be given if 'customer_id' is not specified.\n", "maxLength" : 50, "example" : null }, "customer_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer for whom this estimate is created. Is given if 'subscription_id' is not specified. Applicable only if the 'Consolidated Invoicing' is enabled. If 'Consolidated Invoicing' is not enabled, an invoice will be generated for every subscription.\n", "maxLength" : 50, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", "description" : "Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/unbilled_charges/invoice_unbilled_charges" : { "post" : { "summary" : "Create an invoice for unbilled charges", "description" : "Use this API to bill the [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html). Available Credits and Excess Payments will automatically be applied while creating the invoice.\n\nIf the *Auto Collection* is turned on for the particular customer, the invoice will be created in payment_due state and the payment collection will be scheduled immediately.\n\nDuring invoice creation, the PO number for the line items will be filled from the subscription's current PO number, if available.\n\nIf no recurring item is present in the created invoice, the invoice will be marked as recurring=false.\n\nIf consolidated invoicing is enabled and the parameter 'customer_id' is passed, multiple invoices can be created based on the following factors.\n\n* Currency\n* PO number if 'Group by PO number' is enabled\n* Shipping address\n* Auto Collection\n* Payment method\n", "operationId" : "create_an_invoice_for_unbilled_charges", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "subscription_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the subscription for which this invoice needs to be created. Should be specified if 'customer_id' is not specified.\n", "maxLength" : 50, "example" : null }, "customer_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer for whom this invoice needs to be created. Should be specified if 'subscription_id' is not specified. Applicable only if the consolidated invoicing is enabled. .\n", "maxLength" : 50, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "invoices" : { "type" : "array", "description" : "Resource object representing invoice
", "items" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "example" : null } }, "required" : [ "invoices" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/unbilled_charges" : { "get" : { "summary" : "List unbilled charges", "description" : "This endpoint lists all the unbilled charges.\n", "operationId" : "list_unbilled_charges", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
The price or per-unit-price of the item price. By default, it is the value set\nfor the item_price.\nThis is only applicable when the pricing_model\nof the item_price\nis flat_fee\nor per_unit.\nThe value depends on the type of currency\n.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "unbilled_charges" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders" : { "get" : { "summary" : "List orders", "description" : "This API is used to retrieve a list of all the available orders.\n", "operationId" : "list_orders", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/import_order" : { "post" : { "summary" : "Import an order", "description" : "Import an order for an invoice with one or more line items. The import order bulk operation is to be applied on an imported invoice.\n", "operationId" : "import_an_order", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Uniquely identifies the order. It is the api identifier for the order.\n\n\\*Order id will always be assigned incrementally from the last generated Order ID.\n\nIf Orders imported has an Order ID which is a string, Chargebee will just validate if the Order ID is unique\n\nRecommendation: For orders being imported, set the same prefix and the serial number that is used for the Document number, which will make this into a string. This will ensure that imported orders don't conflict with orders created by Chargebee. Chargebee will ensure there aren't orders with duplicate Order IDs.\\*\n.\n", "maxLength" : 40, "example" : null }, "document_number" : { "type" : "string", "deprecated" : false, "description" : "The order's serial number.\n\n*Document number passed cannot be greater than the series mentioned in the configuration. For instance, if you have set Document number series in Order Configurations with a Prefix as 'ORDER' and Starting number as '1000', orders up to the sequence number 'ORDER999' can be imported into Chargebee*\n\n*Recommendation: Set a different prefix at the Order Configuration, than the ones that are imported. If your Order Configuration has a Prefix of 'NEW', with Starting number as '1', i.e. 'NEW1', then, set Prefix for imported orders to be as 'OLD', with Starting number as '1', i.e, 'OLD1'*\n.\n", "maxLength" : 50, "example" : null }, "invoice_id" : { "type" : "string", "deprecated" : false, "description" : "The invoice number which acts as an identifier for invoice and is generated sequentially.\n", "maxLength" : 50, "example" : null }, "status" : { "type" : "string", "deprecated" : false, "description" : "The status of this order.\n\\* voided -\n\nOrder has been voided. Applicable only if you are using Chargebee's legacy order management system\n\\* complete -\n\nOrder has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n\\* shipped -\n\nThe order has moved from order management system to a shipping system.\n\\* processing -\n\nOrder is being processed. Applicable only if you are using Chargebee's legacy order management system\n\\* queued -\n\nOrder is yet to be processed by any system, these are scheduled orders created by Chargebee\n\\* on_hold -\n\nThe order is paused from being processed.\n\\* new -\n\nOrder has been created. Applicable only if you are using Chargebee's legacy order management system.\n\\* returned -\n\nThe order has been returned after delivery.\n\\* delivered -\n\nThe order has been delivered to the customer.\n\\* awaiting_shipment -\n\nThe order has been picked up by an integration system, and synced to a shipping management platform\n\\* cancelled -\n\nOrder has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n\\* partially_delivered -\n\nThe order has been partially delivered to the customer.\n", "enum" : [ "cancelled", "queued", "awaiting_shipment", "on_hold", "delivered", "shipped", "partially_delivered", "returned" ], "example" : null }, "subscription_id" : { "type" : "string", "deprecated" : false, "description" : "The subscription for which the order is created.\n", "maxLength" : 50, "example" : null }, "customer_id" : { "type" : "string", "deprecated" : false, "description" : "The customer for which the order is created.\n", "maxLength" : 50, "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time at which the order was created.\n", "example" : null }, "order_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The date on which the order will start getting processed.\n", "example" : null }, "shipping_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "This is the date on which the order has to be shipped to the customer.\n", "example" : null }, "reference_id" : { "type" : "string", "deprecated" : false, "description" : "Reference id can be used to map the orders in the shipping/order management application to the orders in ChargeBee. The reference_id generally is the same as the order id in the third party application.\n\n*Recommendation:\nIf this order is in any of these statuses, awaiting_shipment, on_hold, delivered, shipped, partially_delivered, returned, and has already been processed, through a 3rd party system, and you have a reference id of the entity in the 3rd party tool, pass in the entity id to this field. If not, set the same prefix and the serial number that is used for the Document number, which will make this into a string.*\n\n*If this order hasn't been processed and is in 'queued' status, do not pass any value to this field. Chargebee, when it syncs your Orders through the fulfilment integrations such as Shipstation or Shopify, would auto assign the reference id from the connected system.*\n.\n", "maxLength" : 50, "example" : null }, "fulfillment_status" : { "type" : "string", "deprecated" : false, "description" : "The fulfillment status of an order as reflected in the shipping/order management application. Typical statuses include Shipped,Awaiting Shipment,Not fulfilled etc;.\n\n\\*If this order is in any of these statuses, awaiting_shipment, on_hold, delivered, shipped, partially_delivered, returned, and has already been processed, through a 3rd party system, and you have a corresponding status from the 3rd party tool, pass in the status to this field.\n\nIf this order hasn't been processed and is in 'queued' status, do not pass any value to this field. Chargebee, when it syncs your Orders through the fulfilment integrations such as Shipstation or Shopify, would auto assign the fulfilment status from the connected system.\\*\n.\n", "maxLength" : 50, "example" : null }, "note" : { "type" : "string", "deprecated" : false, "description" : "The custom note for the order.\n", "maxLength" : 600, "example" : null }, "tracking_id" : { "type" : "string", "deprecated" : false, "description" : "The tracking id of the order.\n", "maxLength" : 50, "example" : null }, "tracking_url" : { "type" : "string", "deprecated" : false, "description" : "The tracking url of the order.\n", "maxLength" : 255, "example" : null }, "batch_id" : { "type" : "string", "deprecated" : false, "description" : "Unique id to identify a group of orders.\n", "maxLength" : 50, "example" : null }, "shipment_carrier" : { "type" : "string", "deprecated" : false, "description" : "Shipment carrier.\n", "maxLength" : 50, "example" : null }, "shipping_cut_off_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time after which an order becomes unservicable.\n", "example" : null }, "delivered_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time at which the order was delivered.\n", "example" : null }, "shipped_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time at which the order was shipped.\n", "example" : null }, "cancelled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time at which the order was cancelled.\n", "example" : null }, "cancellation_reason" : { "type" : "string", "deprecated" : false, "description" : "Cancellation reason.\n\\* shipping_cut_off_passed -\n\nThe invoice has been paid late and Chargebee cancel's the first order for the invoice.\n\\* invoice_voided -\n\nThe invoice for which the order was createed has been voided.\n\\* alternative_found -\n\nAlternative found.\n\\* others -\n\nOther reason\n\\* order_resent -\n\nOrder resent\n\\* product_unsatisfactory -\n\nProduct unsatisfactory.\n\\* delivery_date_missed -\n\nDelivery date missed.\n\\* subscription_cancelled -\n\nThe subsctiption for which the order was created has been cancelled.\n\\* fraudulent_transaction -\n\nFraudulent transaction.\n\\* invoice_written_off -\n\nThe invoice has been completely written off. Orders are generated by Chargebee in cancelled state.\n\\* product_not_required -\n\nProduct not required.\n\\* payment_declined -\n\nPayment declined.\n\\* product_not_available -\n\nProduct not available.\n\\* third_party_cancellation -\n\nThird party cancellation.\n", "enum" : [ "shipping_cut_off_passed", "product_unsatisfactory", "third_party_cancellation", "product_not_required", "delivery_date_missed", "alternative_found", "invoice_written_off", "invoice_voided", "fraudulent_transaction", "payment_declined", "subscription_cancelled", "product_not_available", "others", "order_resent" ], "example" : null }, "refundable_credits_issued" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "If there are any credits that were issued at the order level, you can make use of the field, refundable_credits_issued. This will lead to Chargebee creating a Refundable Credit note against the order. When the next invoice is raised against the customer, this credit note will be utilised.\n", "minimum" : 0, "example" : null }, "shipping_address" : { "type" : "object", "deprecated" : false, "description" : "Parameters for shipping_address\n", "properties" : { "first_name" : { "type" : "string", "deprecated" : false, "description" : "The first name of the contact.\n", "maxLength" : 150, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "The last name of the contact.\n", "maxLength" : 150, "example" : null }, "email" : { "type" : "string", "format" : "email", "deprecated" : false, "description" : "The email address.\n", "maxLength" : 70, "example" : null }, "company" : { "type" : "string", "deprecated" : false, "description" : "The company name.\n", "maxLength" : 250, "example" : null }, "phone" : { "type" : "string", "deprecated" : false, "description" : "The phone number.\n", "maxLength" : 50, "example" : null }, "line1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1\n", "maxLength" : 150, "example" : null }, "line2" : { "type" : "string", "deprecated" : false, "description" : "Address line 2\n", "maxLength" : 150, "example" : null }, "line3" : { "type" : "string", "deprecated" : false, "description" : "Address line 3\n", "maxLength" : 150, "example" : null }, "city" : { "type" : "string", "deprecated" : false, "description" : "The name of the city.\n", "maxLength" : 50, "example" : null }, "state_code" : { "type" : "string", "deprecated" : false, "description" : "The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/assign_order_number" : { "post" : { "summary" : "Assign order number", "description" : "Assigns order number to the order based on the settings, if not already assigned\n", "operationId" : "assign_order_number", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "order-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/order-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "order" : { "$ref" : "#/components/schemas/Order", "description" : "Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/resend" : { "post" : { "summary" : "Resend an order", "description" : "Resend an existing order. This will help in resending an existing order in full or partial. Upto 5 resend operations are allowed per . When resent fully, the original order is canceled.\n", "operationId" : "resend_an_order", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "order-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/order-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "shipping_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The date on which the order should be shipped to the customer.\n", "example" : null }, "resend_reason" : { "type" : "string", "deprecated" : false, "description" : "Reason code for resending the order. Must be one from a list of reason codes set in the Chargebee app in **Settings \\> Configure Chargebee \\> Reason Codes \\> Orders \\> Order Resend**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n", "maxLength" : 100, "example" : null }, "order_line_items" : { "type" : "object", "deprecated" : false, "description" : "Parameters for order_line_items\n", "properties" : { "id" : { "type" : "array", "description" : "The identifier for the order line item.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 40, "example" : null }, "example" : null }, "fulfillment_quantity" : { "type" : "array", "description" : "The quantity that is going to get fulfilled for this order\n", "items" : { "type" : "integer", "format" : "int32", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null } }, "example" : null } }, "example" : null }, "encoding" : { "order_line_items" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "order" : { "$ref" : "#/components/schemas/Order", "description" : "Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/reopen" : { "post" : { "summary" : "Reopen a cancelled order", "description" : "This API is used to re-open a cancelled order\n", "operationId" : "reopen_a_cancelled_order", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "order-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/order-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "void_cancellation_credit_notes" : { "type" : "boolean", "deprecated" : false, "description" : "Flag to void credit notes created for cancellation if they are unused.\n", "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "order" : { "$ref" : "#/components/schemas/Order", "description" : "Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/cancel" : { "post" : { "summary" : "Cancel an order", "description" : "Cancel order and create a refundable credit note for the order\n", "operationId" : "cancel_an_order", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "order-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/order-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "cancellation_reason" : { "type" : "string", "deprecated" : false, "description" : "Cancellation reason.\n\\* shipping_cut_off_passed -\n\nThe invoice has been paid late and Chargebee cancel's the first order for the invoice.\n\\* alternative_found -\n\nAlternative found.\n\\* others -\n\nOther reason\n\\* product_unsatisfactory -\n\nProduct unsatisfactory.\n\\* product_not_required -\n\nProduct not required.\n\\* delivery_date_missed -\n\nDelivery date missed.\n\\* invoice_voided -\n\nThe invoice for which the order was createed has been voided.\n\\* payment_declined -\n\nPayment declined.\n\\* product_not_available -\n\nProduct not available.\n\\* subscription_cancelled -\n\nThe subsctiption for which the order was created has been cancelled.\n\\* third_party_cancellation -\n\nThird party cancellation.\n\\* fraudulent_transaction -\n\nFraudulent transaction.\n\\* order_resent -\n\nOrder resent\n\\* invoice_written_off -\n\nThe invoice has been completely written off. Orders are generated by Chargebee in cancelled state.\n", "enum" : [ "shipping_cut_off_passed", "product_unsatisfactory", "third_party_cancellation", "product_not_required", "delivery_date_missed", "alternative_found", "invoice_written_off", "invoice_voided", "fraudulent_transaction", "payment_declined", "subscription_cancelled", "product_not_available", "others", "order_resent" ], "example" : null }, "customer_notes" : { "type" : "string", "deprecated" : false, "description" : "The Customer Notes to be filled in the Credit Notes created to capture this refund detail.\n", "maxLength" : 2000, "example" : null }, "comment" : { "type" : "string", "deprecated" : false, "description" : "Comment, if any, on the refund.\n", "maxLength" : 300, "example" : null }, "cancelled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time at which the order was cancelled.\n", "example" : null }, "credit_note" : { "type" : "object", "deprecated" : false, "description" : "Parameters for credit_note\n", "properties" : { "total" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "Credit Note amount in cents.\n", "minimum" : 0, "example" : null } }, "example" : null } }, "required" : [ "cancellation_reason" ], "example" : null }, "encoding" : { "credit_note" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "order" : { "$ref" : "#/components/schemas/Order", "description" : "Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}" : { "get" : { "summary" : "Retrieve an order", "description" : "Retrieves an order corresponding to the order id passed.\n", "operationId" : "retrieve_an_order", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "order-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/order-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "order" : { "$ref" : "#/components/schemas/Order", "description" : "Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update an order", "description" : "Updates an order. If the status of an order is changed while updating the order, the status_update_at attribute is set with the current time.\n", "operationId" : "update_an_order", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "order-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/order-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "reference_id" : { "type" : "string", "deprecated" : false, "description" : "Reference id is the unique identifier of the order in the shipping/order management application.\n", "maxLength" : 50, "example" : null }, "batch_id" : { "type" : "string", "deprecated" : false, "description" : "Unique id to identify a group of orders.\n", "maxLength" : 50, "example" : null }, "note" : { "type" : "string", "deprecated" : false, "description" : "The custom note for the order.\n", "maxLength" : 600, "example" : null }, "shipping_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The date on which the order should be shipped to the customer.\n", "example" : null }, "order_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The order date.\n", "example" : null }, "cancelled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time at which the order was cancelled.\n", "example" : null }, "cancellation_reason" : { "type" : "string", "deprecated" : false, "description" : "Cancellation reason.\n\\* shipping_cut_off_passed -\n\nThe invoice has been paid late and Chargebee cancel's the first order for the invoice.\n\\* invoice_voided -\n\nThe invoice for which the order was createed has been voided.\n\\* alternative_found -\n\nAlternative found.\n\\* others -\n\nOther reason\n\\* order_resent -\n\nOrder resent\n\\* product_unsatisfactory -\n\nProduct unsatisfactory.\n\\* delivery_date_missed -\n\nDelivery date missed.\n\\* subscription_cancelled -\n\nThe subsctiption for which the order was created has been cancelled.\n\\* fraudulent_transaction -\n\nFraudulent transaction.\n\\* invoice_written_off -\n\nThe invoice has been completely written off. Orders are generated by Chargebee in cancelled state.\n\\* product_not_required -\n\nProduct not required.\n\\* payment_declined -\n\nPayment declined.\n\\* product_not_available -\n\nProduct not available.\n\\* third_party_cancellation -\n\nThird party cancellation.\n", "enum" : [ "shipping_cut_off_passed", "product_unsatisfactory", "third_party_cancellation", "product_not_required", "delivery_date_missed", "alternative_found", "invoice_written_off", "invoice_voided", "fraudulent_transaction", "payment_declined", "subscription_cancelled", "product_not_available", "others", "order_resent" ], "example" : null }, "shipped_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time at which the order was shipped.\n", "example" : null }, "delivered_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time at which the order was delivered.\n", "example" : null }, "tracking_url" : { "type" : "string", "deprecated" : false, "description" : "The tracking url of the order.\n", "maxLength" : 255, "example" : null }, "tracking_id" : { "type" : "string", "deprecated" : false, "description" : "The tracking id of the order.\n", "maxLength" : 50, "example" : null }, "shipment_carrier" : { "type" : "string", "deprecated" : false, "description" : "The carrier used to ship the goods to the customer. Ex:- FedEx.\n", "maxLength" : 50, "example" : null }, "fulfillment_status" : { "type" : "string", "deprecated" : false, "description" : "The fulfillment status of an order as reflected in the shipping/order management application. Typical statuses include Shipped,Awaiting Shipment,Not fulfilled etc;.\n", "maxLength" : 50, "example" : null }, "status" : { "type" : "string", "default" : "new", "deprecated" : false, "description" : "The order status.\n\\* voided -\n\nOrder has been voided. Applicable only if you are using Chargebee's legacy order management system\n\\* complete -\n\nOrder has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n\\* shipped -\n\nThe order has moved from order management system to a shipping system.\n\\* processing -\n\nOrder is being processed. Applicable only if you are using Chargebee's legacy order management system\n\\* queued -\n\nOrder is yet to be processed by any system, these are scheduled orders created by Chargebee\n\\* on_hold -\n\nThe order is paused from being processed.\n\\* new -\n\nOrder has been created. Applicable only if you are using Chargebee's legacy order management system.\n\\* returned -\n\nThe order has been returned after delivery.\n\\* delivered -\n\nThe order has been delivered to the customer.\n\\* awaiting_shipment -\n\nThe order has been picked up by an integration system, and synced to a shipping management platform\n\\* cancelled -\n\nOrder has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n\\* partially_delivered -\n\nThe order has been partially delivered to the customer.\n", "enum" : [ "new", "processing", "complete", "cancelled", "voided", "queued", "awaiting_shipment", "on_hold", "delivered", "shipped", "partially_delivered", "returned" ], "example" : null }, "shipping_address" : { "type" : "object", "deprecated" : false, "description" : "Parameters for shipping_address\n", "properties" : { "first_name" : { "type" : "string", "deprecated" : false, "description" : "The first name of the contact.\n", "maxLength" : 150, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "The last name of the contact.\n", "maxLength" : 150, "example" : null }, "email" : { "type" : "string", "format" : "email", "deprecated" : false, "description" : "The email address.\n", "maxLength" : 70, "example" : null }, "company" : { "type" : "string", "deprecated" : false, "description" : "The company name.\n", "maxLength" : 250, "example" : null }, "phone" : { "type" : "string", "deprecated" : false, "description" : "The phone number.\n", "maxLength" : 50, "example" : null }, "line1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1\n", "maxLength" : 150, "example" : null }, "line2" : { "type" : "string", "deprecated" : false, "description" : "Address line 2\n", "maxLength" : 150, "example" : null }, "line3" : { "type" : "string", "deprecated" : false, "description" : "Address line 3\n", "maxLength" : 150, "example" : null }, "city" : { "type" : "string", "deprecated" : false, "description" : "The name of the city.\n", "maxLength" : 50, "example" : null }, "state_code" : { "type" : "string", "deprecated" : false, "description" : "The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/delete" : { "post" : { "summary" : "Delete an imported order", "description" : "Deletes only [Imported Order](/docs/api/orders/import-an-order)\n.Delete does not happen if the order was refunded. It goes through if order refund was initiated and is in \"refund_due\" state.\n", "operationId" : "delete_an_imported_order", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "order-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/order-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "order" : { "$ref" : "#/components/schemas/Order", "description" : "Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/create_refundable_credit_note" : { "post" : { "summary" : "Create a refundable credit note", "description" : "This API is used to create a refundable credit note for the order\n", "operationId" : "create_a_refundable_credit_note", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "order-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/order-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "customer_notes" : { "type" : "string", "deprecated" : false, "description" : "The Customer Notes to be filled in the Credit Notes created to capture this refund detail.\n", "maxLength" : 2000, "example" : null }, "comment" : { "type" : "string", "deprecated" : false, "description" : "Comment, if any, on the refund.\n", "maxLength" : 300, "example" : null }, "credit_note" : { "type" : "object", "deprecated" : false, "description" : "Parameters for credit_note\n", "properties" : { "reason_code" : { "type" : "string", "deprecated" : false, "description" : "The reason for issuing this Credit Note. The following reason codes are supported now\\[Deprecated; use the [create_reason_code](/docs/api/credit_notes/credit_note-object#create_reason_code)\nparameter instead\\]\n\\* product_unsatisfactory -\n\nProduct Unsatisfactory\n\\* chargeback -\n\nCan be set when you are recording your customer Chargebacks\n\\* service_unsatisfactory -\n\nService Unsatisfactory\n\\* write_off -\n\nThis reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)\noperation.\n\\* subscription_change -\n\nThis reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\nis enabled\n\\* fraudulent -\n\nFRAUDULENT\n\\* other -\n\nCan be set when none of the above reason codes are applicable\n\\* subscription_pause -\n\nThis reason will be automatically set to credit notes created during pause/resume subscription operation.\n\\* waiver -\n\nWaiver\n\\* order_cancellation -\n\nOrder Cancellation\n\\* order_change -\n\nOrder Change\n\\* subscription_cancellation -\n\nThis reason will be set automatically for Credit Notes created during cancel subscription operation\n", "enum" : [ "write_off", "subscription_change", "subscription_cancellation", "subscription_pause", "chargeback", "product_unsatisfactory", "service_unsatisfactory", "order_change", "order_cancellation", "waiver", "other", "fraudulent" ], "example" : null }, "total" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "Credit Note amount in cents.\n", "minimum" : 0, "example" : null } }, "required" : [ "reason_code", "total" ], "example" : null } }, "example" : null }, "encoding" : { "credit_note" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "order" : { "$ref" : "#/components/schemas/Order", "description" : "Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/gifts/create_for_items" : { "post" : { "summary" : "Create a gift subscription for items", "description" : "Create a gift subscription with items like plans, addons, or charges and gift it to an existing customer.\n", "operationId" : "create_a_gift_subscription_for_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "scheduled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.\n", "example" : null }, "auto_claim" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "When true\n, the claim happens automatically. When not passed, the default value in the site settings is used.
When true\n, indicates that the gift does not expire. Do not pass or pass as false\nwhen auto_claim\nis set.\n.
The date until which the gift can be claimed. Must be set to a value after scheduled_at.\nIf the gift is not claimed within claim_expiry_date\n, it will expire and the subscription will move to cancelled\nstate. When not passed, the value specified in the site settings will be used.\nPass as NULL\nor do not pass when auto_claim\nor no_expiry\nare set.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The price/per unit price of the item. The value is interpreted as per the type of currency.
\nPrerequisites
pricing_model of the item price is flat_fee or per_unit.Default value
item_price.price.The price/per unit price of the item in major units of the currency. When not provided, the value set for the item price is used.
\nPrerequisites
pricing_model of the item price is flat_fee or per_unit.Default value
The lowest value in the quantity tier.
\nConstraints
ending_unit of the next lower tier.The highest value in the quantity tier.
\nConstraints
starting_unit of the next higher tier.The decimal representation of the lowest value of quantity in this tier.
\nConstraints
ending_unit_in_decimal of the next lower tier.Prerequisite
The decimal representation of the highest value of quantity in this tier.
\nConstraints
starting_unit_in_decimal of the next higher tier.Prerequisite
tiered or volume.stairstep.Constraints
Prerequisite
Resource object representing gift
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" } }, "required" : [ "gift", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/gifts/{gift-id}/cancel" : { "post" : { "summary" : "Cancel a gift", "description" : "This API allows to cancel gifts. Only gift in 'scheduled' and 'unclaimed' states can be cancelled.\n", "operationId" : "cancel_a_gift", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "gift-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/gift-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "gift" : { "$ref" : "#/components/schemas/Gift", "description" : "Resource object representing gift
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" } }, "required" : [ "gift", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/gifts/{gift-id}/update_gift" : { "post" : { "summary" : "Update a gift", "description" : "Change the date/time at which the gift notification email is to be sent. This only applies to gifts in the scheduled [status](/docs/api/gifts/gift-object#status)\n.\n", "operationId" : "update_a_gift", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "gift-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/gift-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "scheduled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The new date/time at which the gift notification email is to be sent. The value must be greater than current time. If [no_expiry](/docs/api/gifts/gift-object#no_expiry)\nis false then the value must also be less than [claim_expiry_date](/docs/api/gifts/gift-object#claim_expiry_date)\n.\n", "example" : null }, "comment" : { "type" : "string", "deprecated" : false, "description" : "An internal comment for this action. The comments are not retrievable via API and are only available on request via [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support)\n.\n", "maxLength" : 250, "example" : null } }, "required" : [ "scheduled_at" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "gift" : { "$ref" : "#/components/schemas/Gift", "description" : "Resource object representing gift
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" } }, "required" : [ "gift", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/gifts" : { "get" : { "summary" : "List gifts", "description" : "Retrieves the list of gifts.\n", "operationId" : "list_gifts", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Resource object representing gift
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" } }, "required" : [ "gift", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/gifts/{gift-id}/claim" : { "post" : { "summary" : "Claim a gift", "description" : "Claiming a gift will move the status to 'claimed'. Only gifts in 'unclaimed' state can be claimed.\n", "operationId" : "claim_a_gift", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "gift-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/gift-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "gift" : { "$ref" : "#/components/schemas/Gift", "description" : "Resource object representing gift
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" } }, "required" : [ "gift", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions" : { "get" : { "summary" : "List transactions", "description" : "Lists all the transactions.\n", "operationId" : "list_transactions", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
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 ",
"enum" : [ "card", "cash", "check", "chargeback", "bank_transfer", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "other", "upi", "netbanking_emandates", "custom", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `card` - Card\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 ",
"enum" : [ "card", "cash", "check", "chargeback", "bank_transfer", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "other", "upi", "netbanking_emandates", "custom", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `card` - Card\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 ",
"enum" : [ "card", "cash", "check", "chargeback", "bank_transfer", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "other", "upi", "netbanking_emandates", "custom", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna" ],
"pattern" : "^\\[(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna)(,(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `card` - Card\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 ",
"enum" : [ "card", "cash", "check", "chargeback", "bank_transfer", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "other", "upi", "netbanking_emandates", "custom", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna" ],
"pattern" : "^\\[(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna)(,(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna))*\\]$",
"example" : null
}
}
}
}, {
"name" : "gateway",
"in" : "query",
"description" : "optional, enumerated string filter\n\nGateway through which this transaction was done. Applicable only for 'Card' Payment Method. Possible values are : chargebee, chargebee_payments, stripe, wepay, braintree, authorize_net, paypal_pro, pin, eway, eway_rapid, worldpay, balanced_payments, beanstream, bluepay, elavon, first_data_global, hdfc, migs, nmi, ogone, paymill, paypal_payflow_pro, sage_pay, tco, wirecard, amazon_payments, paypal_express_checkout, gocardless, adyen, orbital, moneris_us, moneris, bluesnap, cybersource, vantiv, checkout_com, paypal, ingenico_direct, exact, mollie, quickbooks, razorpay, not_applicable.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*gateway\\[is\\] = \"stripe\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "stripe",
"properties" : {
"is" : {
"type" : "string",
"description" : "* `chargebee` - Chargebee test gateway.\n* `chargebee_payments` - Chargebee Payments gateway\n* `adyen` - Adyen is a payment gateway.\n* `stripe` - Stripe is a payment gateway.\n* `wepay` - WePay is a payment gateway.\n* `braintree` - Braintree is a payment gateway.\n* `authorize_net` - Authorize.net is a payment gateway\n* `paypal_pro` - PayPal Pro Account is a payment gateway.\n* `pin` - Pin is a payment gateway\n* `eway` - eWAY Account is a payment gateway.\n* `eway_rapid` - eWAY Rapid is a payment gateway.\n* `worldpay` - WorldPay is a payment gateway\n* `balanced_payments` - Balanced is a payment gateway\n* `beanstream` - Bambora(formerly known as Beanstream) is a payment gateway.\n* `bluepay` - BluePay is a payment gateway.\n* `elavon` - Elavon Virtual Merchant is a payment solution.\n* `first_data_global` - First Data Global Gateway Virtual Terminal Account\n* `hdfc` - HDFC Account is a payment gateway.\n* `migs` - MasterCard Internet Gateway Service payment gateway.\n* `nmi` - NMI is a payment gateway.\n* `ogone` - Ingenico ePayments (formerly known as Ogone) is a payment gateway.\n* `paymill` - PAYMILL is a payment gateway.\n* `paypal_payflow_pro` - PayPal Payflow Pro is a payment gateway.\n* `sage_pay` - Sage Pay is a payment gateway.\n* `tco` - 2Checkout is a payment gateway.\n* `wirecard` - WireCard Account is a payment service provider.\n* `amazon_payments` - Amazon Payments is a payment service provider.\n* `paypal_express_checkout` - PayPal Express Checkout is a payment gateway.\n* `gocardless` - GoCardless is a payment service provider.\n* `orbital` - Chase Paymentech(Orbital) is a payment gateway.\n* `moneris_us` - Moneris USA is a payment gateway.\n* `moneris` - Moneris is a payment gateway.\n* `bluesnap` - BlueSnap is a payment gateway.\n* `cybersource` - CyberSource is a payment gateway.\n* `vantiv` - Vantiv is a payment gateway.\n* `checkout_com` - Checkout.com is a payment gateway.\n* `paypal` - PayPal Commerce is a payment gateway.\n* `ingenico_direct` - Worldline Online Payments is a payment gateway.\n* `exact` - Exact Payments is a payment gateway.\n* `mollie` - Mollie is a payment gateway.\n* `quickbooks` - Intuit QuickBooks Payments gateway\n* `razorpay` - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.\n* `global_payments` - Global Payments is a payment service provider.\n* `bank_of_america` - Bank of America Gateway\n* `ecentric` - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.\n* `metrics_global` - Metrics global is a leading payment service provider providing unified payment services in the US.\n* `windcave` - Windcave provides an end to end payment processing solution in ANZ and other leading global markets.\n* `pay_com` - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.\n* `ebanx` - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.\n* `dlocal` - Dlocal provides payment solutions for global commerce by accepting local payment methods.\n* `nuvei` - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. \n* `solidgate` - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. \n* `paystack` - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. \n* `jp_morgan` - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.optional, string filter
\nThe reference number for this transaction. For example, the check number when payment_method\n= check\n.\nSupported operators :\nis, is_not, starts_with, is_present
Example →\nreference_number[is] = "cus_u239732"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "cus_u239732", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "type", "in" : "query", "description" : "optional, enumerated string filter\n\nType of the transaction. Possible values are : authorization, payment, refund, payment_reversal.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*type\\[is_not\\] = \"payment\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "payment", "properties" : { "is" : { "type" : "string", "description" : "* `authorization` - The transaction represents an authorization for capturing theamount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"pattern" : "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"pattern" : "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\]$",
"example" : null
}
}
}
}, {
"name" : "date",
"in" : "query",
"description" : "optional, timestamp(UTC) in seconds filter\n\nIndicates when this transaction occurred.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*date\\[before\\] = \"1435054328\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "1435054328",
"properties" : {
"after" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"before" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"on" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"between" : {
"type" : "string",
"pattern" : "^\\[\\d{10},\\d{10}\\]$",
"example" : null
}
}
}
}, {
"name" : "amount",
"in" : "query",
"description" : "optional, in cents filter\n\nAmount for this transaction.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*amount\\[gt\\] = \"1200\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "1200",
"properties" : {
"is" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"is_not" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"lt" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"lte" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"gt" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"gte" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"between" : {
"type" : "string",
"pattern" : "^\\[-?\\d+,-?\\d+\\]$",
"example" : null
}
}
}
}, {
"name" : "amount_capturable",
"in" : "query",
"description" : "optional, in cents filter\n\nTo filter based on transaction's unused authorized/blocked amount.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*amount_capturable\\[lt\\] = \"1200\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "1200",
"properties" : {
"is" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"is_not" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"lt" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"lte" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"gt" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"gte" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"between" : {
"type" : "string",
"pattern" : "^\\[-?\\d+,-?\\d+\\]$",
"example" : null
}
}
}
}, {
"name" : "status",
"in" : "query",
"description" : "optional, enumerated string filter\n\nThe status of this transaction. Possible values are : in_progress, success, voided, failure, timeout, needs_attention.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is\\] = \"success\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "success",
"properties" : {
"is" : {
"type" : "string",
"description" : "\\* \\`in_progress\\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
"enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "\\* \\`in_progress\\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
"enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "\\* \\`in_progress\\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
"enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ],
"pattern" : "^\\[(in_progress|success|voided|failure|timeout|needs_attention|late_failure)(,(in_progress|success|voided|failure|timeout|needs_attention|late_failure))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "\\* \\`in_progress\\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
"enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ],
"pattern" : "^\\[(in_progress|success|voided|failure|timeout|needs_attention|late_failure)(,(in_progress|success|voided|failure|timeout|needs_attention|late_failure))*\\]$",
"example" : null
}
}
}
}, {
"name" : "updated_at",
"in" : "query",
"description" : "optional, timestamp(UTC) in seconds filter
\nTo filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[after] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\ndate, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"date\"*\n\nThis will sort the result based on the 'date' attribute in ascending(earliest first) order.\n", "required" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "asc" : { "type" : "string", "enum" : [ "date", "updated_at" ], "example" : null }, "desc" : { "type" : "string", "enum" : [ "date", "updated_at" ], "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/{transaction-id}/reconcile" : { "post" : { "summary" : "Reconcile transaction", "description" : "Update selected attributes of the transaction resource: status, id_at_gateway, and customer_id. Use this API for reconciliation purposes where the status of a transaction is in needs_attention that can be updated to either success or failure status.
The identifier with which this transaction is referred in gateway. The id_at_gateway\ncan only be updated when the transaction status is in needs_attention.
Note:
needs_attention to success. It is recommended to pass this value if available in the gateway.id_at_gateway value does not match the id_at_gateway value stored against the transaction in Chargebee.Unique identifier of the customer for which this transaction is made. This is needed only when the transaction is successful but not associated with any customer.
\nNote:
An error occurs when the provided customer_id\nvalue does not match the customer_id\nvalue stored against the transaction in Chargebee.
The status of this transaction. The status can only be updated when the transaction status is in needs_attention\nstate.
When the transaction is in failure status.
\nNote:
When the transaction is updated to failure status and the invoice is associated with the transaction,
payment_due status if the dunning is configured.not_paid status if the dunning is not configured.When the transaction is successful.
\nNote:
When the transaction is updated to success\nstatus, - and the invoice is associated with the transaction, the transaction amount will be applied to the invoice.
customer_excess_payments will be updated.Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/{transaction-id}" : { "get" : { "summary" : "Retrieve a transaction", "description" : "Retrieve a transaction identified by its unique id.\n", "operationId" : "retrieve_a_transaction", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "transaction-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/transaction-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/{transaction-id}/refund" : { "post" : { "summary" : "Refund a payment", "description" : "Refunds an online payment. Applicable only for transactions of type = payment. You can only refund a transaction whose status is success.
The amount to be refunded. Must not exceed amount_unused.\nIf not passed then all of amount_unused\nis refunded.
Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/{transaction-id}/record_refund" : { "post" : { "summary" : "Record an offline refund", "description" : "Records a refund made offline. Applicable only for transactions of type = payment.
The amount to be recorded as refunded. Must not exceed amount_unused.\nIf not passed then all of amount_unused\nis recorded as refunded.
The payment method used to make the refund.
\n* card -Card
\n* custom -Custom
\n* naver_pay -Payments made via Naver Pay.
\n\n* venmo -Venmo
\n\n* amazon_payments -Amazon Payments
\n* ideal -IDEAL
\n* boleto -boleto
\n* chargeback -Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.
Automated Bank Transfer
\n\n* google_pay -Google Pay
\n* netbanking_emandates -netbanking_emandates
\n* unionpay -Unionpay
\n* pay_to -PayTo
\n\n* bank_transfer -Bank Transfer
\n* paypal_express_checkout -Paypal Express Checkout
\n* pay_by_bank -Pay By Bank
\n* electronic_payment_standard -Electronic Payment Standard
\n* direct_debit -Direct Debit
\n* klarna_pay_now -Klarna Pay Now
\n\n* dotpay -Dotpay
\n* other -Payment Methods other than the above types
\n* alipay -Payments made via Alipay.
\n\n* sofort -Sofort
\n* play_store -Play Store
\n* swish -Payments made via Swish
\n\n* sepa_instant_transfer -Sepa Instant Transfer
\n\n* upi -upi
\n* trustly -Trustly
\n* ach_credit -ACH Credit
\n* apple_pay -Apple Pay
\n* grab_pay -Payments made via GrabPay
\n\n* pix -Pix
\n\n* giropay -giropay
\n* pay_co -Payments made via PayCo
\n\n* wechat_pay -Payments made via WeChat Pay.
\n\n* sepa_credit -SEPA Credit
\n* twint -Payments made via Twint
\n\n* revolut_pay -Payments made via Revolut Pay.
\n\n* cash -Cash
\n* after_pay -Payments made via Afterpay
\n\n* kbc_payment_button -KBC Payment Button
\n* bancontact -Bancontact
\n* faster_payments -Faster Payments
\n\n* payconiq_by_bancontact -Payments made via Payconiq by Bancontact.
\n\n* go_pay -Payments made via GoPay
\n\n* kakao_pay -Payments made via Kakao Pay.
\n\n* app_store -App Store
\n* check -Check
\n* payme -Payments made via PayMe
\n\n* stablecoin -Payments made via Stablecoin.
\n\n* cash_app_pay -Payments made via Cash App Pay.
\n", "enum" : [ "cash", "check", "chargeback", "bank_transfer", "other", "custom" ], "example" : null }, "date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The date when the refund was made.\n", "example" : null }, "reference_number" : { "type" : "string", "deprecated" : false, "description" : "The reference number for this transaction. For example, the check number when payment_method\n= check\n.
Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/{transaction-id}/void" : { "post" : { "summary" : "Void an authorization transaction", "description" : "This API voids the specific authorization transaction in order to release the blocked funds from the customer's card. Voiding an already captured or voided transaction is not possible.\n", "operationId" : "void_an_authorization_transaction", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "transaction-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/transaction-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/create_authorization" : { "post" : { "summary" : "Create an authorization payment", "description" : "Authorizes a specific amount in customer's Credit card, which can be collected within a span of time. Read more on authorization and capture [here](https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/stripe#auth-and-capture). \n* Supported only for Card payments.\n* Currently supported only for **Stripe**.\n", "operationId" : "create_an_authorization_payment", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "customer_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer.\n", "maxLength" : 50, "example" : null }, "payment_source_id" : { "type" : "string", "deprecated" : false, "description" : "Payment source to be used for authorizing the transaction.\n", "maxLength" : 40, "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "The currency code (ISO 4217 format) of the transaction amount.\n", "maxLength" : 3, "example" : null }, "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The amount to be blocked.\n", "minimum" : 1, "example" : null } }, "required" : [ "amount", "customer_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/payments" : { "get" : { "summary" : "List payments for an invoice", "description" : "Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \\& automatic) made for this invoice.\n", "operationId" : "list_payments_for_an_invoice", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "invoice-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/invoice-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/{transaction-id}/delete_offline_transaction" : { "post" : { "summary" : "Delete an offline transaction", "description" : "This API deletes an offline transaction. However, to delete an offline transaction all payment allocations associated with the transaction must be removed.\n", "operationId" : "delete_an_offline_transaction", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "transaction-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/transaction-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "comment" : { "type" : "string", "deprecated" : false, "description" : "Reason for deleting this transaction. This comment will be added to the associated entity.\n", "maxLength" : 300, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/checkout_one_time_for_items" : { "post" : { "summary" : "Checkout charge-items and one-time charges", "description" : "Create a Chargebee hosted page to accept payment details from a customer and checkout charge-items and one-time charges.
The following steps describe how best to use this API:
pass_thru_content containing information and IDs from your systems that must be associated with the checkout page.url received in the response.customer record in Chargebee, and they are redirected to the redirect_url with the id and state attributes passed as query string parameters.When customer[id] is provided for this operation, it is looked up by Chargebee, and if found, the hosted_page is created for it. If not found, a new customer resource is created with an autogenarated ID, and the hosted_page is created.
If multiple business entities are created for the site, the customer resource lookup and creation happen within the context of the business entity specified in this API call. If no business entity is specified, the customer resource lookup is performed within the site context , and if not found, the resource is created for the default business entity of the site.
The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.
\nNote :
\nredirect_url after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as subscription_created or invoice_generated to verify a successful checkout.This attribute allows you to store custom information with the hosted_page object. You can use it to associate specific data with a hosted page session.\nFor example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the redirect URL's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
The unique ID of the customer for which this hosted_page should be created. If not provided, the ID of the newly created customer resource is autogenerated.
Specifies if the customer is liable for tax
\n* exempt -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.
", "enum" : [ "taxable", "exempt" ], "example" : null }, "vat_number" : { "type" : "string", "deprecated" : false, "description" : "The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Determines whether the customer is e-invoiced. When set to true\nor not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (billing_address.country\n). When set to false\n, the customer is not e-invoiced even if e-invoicing is enabled for their country.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
Indicates whether invoices raised on the same day for the customer are consolidated. When provided, this overrides the default configuration at the site-level. This parameter can be provided only when Consolidated Invoicing is enabled.
Note:
Any invoices raised when a subscription activates from in_trial or future status, are not consolidated by default. Contact Support to enable consolidation for such invoices.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The price or per-unit-price of the item price. By default, it is the value set\nfor the item_price.\nThis is only applicable when the pricing_model\nof the item_price\nis flat_fee\nor per_unit.\nThe value depends on the type of currency\n.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
The unique id for the entity_identifier[i]\nin Chargebee. This is required when entity_identifier[operation][i]\nis update\nor delete\n.
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The value of the entity_identifier.\nThis identifies the customer entity on the Peppol network. For example: 10101010-STO-10\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The operation to be performed for the entity_identifier\n.
Creates a new entity_identifier\nfor the customer.
Updates an existing entity_identifier\nfor the customer. entity_identifier[id]\nmust be provided in this case.
Deletes an existing entity_identifier\nfor the customer. entity_identifier[id]\nmust be provided in this case.
The standard used for specifying the entity_identifier\nscheme.\nCurrently, only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/update_payment_method" : { "post" : { "summary" : "Update payment method", "description" : "**Note:** If you're using [In-App Checkout](https://www.chargebee.com/docs/2.0/checkout.html) , use [Manage Payment Sources API](/docs/api/hosted_pages/manage-payment-sources) to request your customers to update their payment method details or change their payment method.\n\nUsing this API, you can request your customers to update their payment method details or change their payment method. This is used in scenarios like customers updating their payment methods before the end of trial or customers switching among payment methods.\n\nWhen this API is invoked, it returns a hosted page URL. When the customers are directed to this URL, they will be able to change/update their payment methods.\n\nDepending on the payment methods (Card, PayPal Express Checkout, Amazon Payments) that you offer your customers, they will find options to switch among the various methods of payment.\n**Note:**\n\n* If the card\\[gateway\\] parameter is passed, and the customer chooses Card as a payment method, then the card details are stored in the gateway which is passed. However, if the card\\[gateway\\] parameter is passed and the customer chooses PayPal Express Checkout/Amazon Payments as a payment method, the gateway passed will be ignored.\n* The option of embedding into an iframe is not supported for PayPal Express Checkout and Amazon Payments as customers are redirected to the respective website pages. Hence if you have PayPal Express Checkout/Amazon Payments configured and pass the parameter embed=true, this will result in an unsuccessful API request. Also, if you have all the three payment methods (Card, Paypal Express Checkout and Amazon Payments) configured and pass the parameter embed=true, the returned hosted page URL will show only Card Payment as a payment method.\n", "operationId" : "update_payment_method", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "redirect_url" : { "type" : "string", "deprecated" : false, "description" : "The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.
\nNote :
\nredirect_url after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as subscription_created or invoice_generated to verify a successful checkout.This attribute allows you to store custom information with the hosted_page object. You can use it to associate specific data with a hosted page session.\nFor example, you can store the ID of the marketing campaign that initiated the user session. After a successful session, when the customer is redirected, you can retrieve the hosted page ID from the redirect URL's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/extend_subscription" : { "post" : { "summary" : "Extend Subscription", "description" : "This API generates a hosted page URL to extend the billing cycle of a subscription.\n", "operationId" : "extend_subscription", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "expiry" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Expiry (in days) for the link generated. No expiry will be set if this is not specified.\n", "maximum" : 500, "minimum" : 1, "example" : null }, "billing_cycle" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of billing cycles by which the subscription should be extended.
\nDefault behavior
billing_cycles set, that value is used.1 is used.Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/events" : { "post" : { "summary" : "Notify an event", "description" : "Use this API to notify Chargebee about important events that occur on your web pages, such as subscription cancellations. An event contains data about affected resources and additional details such as when the change occurred.\n", "operationId" : "notify_an_event", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "event_name" : { "type" : "string", "deprecated" : false, "description" : "The event that need to passed to a different system.\n\\* cancellation_page_loaded -\n\nIndicates native cancellation flow provided by the merchant is loaded rather than the retention flow.\n", "enum" : [ "cancellation_page_loaded" ], "example" : null }, "occurred_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp indicating when this event had occurred.\n.\n", "example" : null }, "event_data" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "The meta data description of the event in key-value pair. The value is a JSON object with the following keys and their values.
\nsubscription_id: A unique and immutable identifier for the subscription.\n.Creates a hosted page for a customer (called the gifter) to gift a subscription to another customer (called the receiver).
When gifter[customer_id] is provided, it is looked up in Chargebee when the gifter completes the hosted page checkout. If not found, a new customer resource is created with this ID.
If multiple business entities are created for the site, the lookup and creation of the gifter customer resource happen within the context of the business entity specified in this API call. If no business entity is specified, the customer resource lookup is performed within the site context, and if not found, the resource is created for the default business entity of the site.
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.
If multiple business entities are created for the site, the lookup and creation of the gift receiver's customer resource happen within the context of the business entity of the gifter
The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.
\nNote :
\nredirect_url after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as subscription_created or invoice_generated to verify a successful checkout.The price/per unit price of the item. The value is interpreted as per the type of currency.
\nPrerequisites
pricing_model of the item price is flat_fee or per_unit.Default value
item_price.price.The price/per unit price of the item in major units of the currency. When not provided, the value set for the item price is used.
\nPrerequisites
pricing_model of the item price is flat_fee or per_unit.Default value
The lowest value in the quantity tier.
\nConstraints
ending_unit of the next lower tier.The highest value in the quantity tier.
\nConstraints
starting_unit of the next higher tier.The decimal representation of the lowest value of quantity in this tier.
\nConstraints
ending_unit_in_decimal of the next lower tier.Prerequisite
The decimal representation of the highest value of quantity in this tier.
\nConstraints
starting_unit_in_decimal of the next higher tier.Prerequisite
tiered or volume.stairstep.Constraints
Prerequisite
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages" : { "get" : { "summary" : "List hosted pages", "description" : "This API retrieves the list of hosted page resources.\n", "operationId" : "list_hosted_pages", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Creates a hosted_page\nresource of type, view_voucher\n. When your end customers choose the Boleto payment method, you can generate a voucher for their pending invoice. Using this API, you can create a voucher_detail hosted page for your customers and email them a link to this hosted page. Your customers can review the voucher details on the page by clicking the link in the email.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/collect_now" : { "post" : { "summary" : "Collect Now", "description" : "This API generates a hosted page URL to collect due payments for the customer.
Chargebee.js openCheckout() not supported
The Chargebee.js openCheckout() function does not support Collect Now hosted pages. To open a Collect Now page, open the url from this API's response in a new browser tab or window (for example, window.open(response.hosted_page.url, '_blank')).
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/accept_quote" : { "post" : { "summary" : "Accept a quote", "description" : "This API generates a hosted page URL for the customer to accept a quote. If the hosted page URL has expired, a new URL will be generated automatically. \n* Customers with existing subscriptions can generate a quote for new subscriptions. However, Hosted page URL to accept a quote cannot be generated for new subscriptions in V1 and V2 hosted pages.\n", "operationId" : "accept_a_quote", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "redirect_url" : { "type" : "string", "deprecated" : false, "description" : "The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.
\nNote :
\nredirect_url after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as subscription_created or invoice_generated to verify a successful checkout.Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/checkout_new_for_items" : { "post" : { "summary" : "Create checkout for a new subscription", "description" : "Create a Chargebee hosted page to accept payment details from a customer and checkout a new subscription.\nThe following steps describe how best to use this API:\nCall this endpoint, providing item prices, coupons and a host of other details such as billing and shipping addresses to be prefilled for the customer on the checkout page. You may also provide pass_thru_content containing information and IDs from your systems that must be associated with the checkout page.
Warning\nThe first item price in the list (parameter subscription_items[item_price_id][0]) must be an item_price of item_type plan.
url received in the response.redirect_url with the id and state attributes passed as query string parameters.\nAlthough the customer will be redirected to the redirect_url after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons. Chargebee recommends listening to appropriate webhooks such as subscription_created or invoice_generated to verify a successful checkout.When the customer[id] parameter is provided and if a customer resource with the ID is found to be already created in Chargebee, the subscription is created under that customer resource. If not found, then a new customer resource is created with an autogenarated ID and the subscription is created under it.
If multiple business entities are created for the site, the customer resource lookup and creation happen within the context of the business entity specified in this API call. If no business entity is specified, the customer resource lookup is performed within the site context, and if not found, the resource is created for the default business entity of the site.
If the billing_address attribute for the customer resource is already set, then the billing_address cannot be edited by the user during the Checkout session. To allow customers to update their billing address, use one of the following options:
openSection() function with options.sectionType set to ADDRESS to display the Customer Portal's address section.billing_address parameters.The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.
\nNote :
\nredirect_url after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as subscription_created or invoice_generated to verify a successful checkout.This attribute allows you to store custom information with the hosted_page object. You can use it to associate specific data with a hosted page session.\nFor example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the redirect URL's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than start_date.\nSet it to 0\nto have no trial period. This parameter overrides the item_price_trial_period\ndirectly.
The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
\nstart_date cannot be earlier than 14th February.Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The unique identifier for the customer resource for which the subscription should be created.
\nSee also\nCustomer resource lookup and creation.
When not provided, a new customer is created with the ID set to the value provided for subscription[id]. If subscription[id] is unavailable, then the customer ID is autogenerated.
Specifies if the customer is liable for tax
\n* exempt -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.
", "enum" : [ "taxable", "exempt" ], "example" : null }, "vat_number" : { "type" : "string", "deprecated" : false, "description" : "The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Determines whether the customer is e-invoiced. When set to true\nor not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (billing_address.country\n). When set to false\n, the customer is not e-invoiced even if e-invoicing is enabled for their country.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The unique identifier of the item price. The first item price in the list (subscription_items[item_price_id][0]\n) must be an item_price\nof item_type\nplan\n.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency. If changes_scheduled_at\nis in the past and a unit_price\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "example" : null } }, "required" : [ "item_price_id" ], "example" : null }, "discounts" : { "type" : "object", "deprecated" : false, "description" : "Parameters for discounts\n", "properties" : { "apply_on" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The unique id for the entity_identifier[i]\nin Chargebee. This is required when entity_identifier[operation][i]\nis update\nor delete\n.
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The value of the entity_identifier.\nThis identifies the customer entity on the Peppol network. For example: 10101010-STO-10\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The operation to be performed for the entity_identifier\n.
Creates a new entity_identifier\nfor the customer.
Updates an existing entity_identifier\nfor the customer. entity_identifier[id]\nmust be provided in this case.
Deletes an existing entity_identifier\nfor the customer. entity_identifier[id]\nmust be provided in this case.
The standard used for specifying the entity_identifier\nscheme.\nCurrently, only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/claim_gift" : { "post" : { "summary" : "Claim a Gift subscription", "description" : "This API generates a hosted page URL to claim a gifted subscription.\n", "operationId" : "claim_a_gift_subscription", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "redirect_url" : { "type" : "string", "deprecated" : false, "description" : "The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.
\nNote :
\nredirect_url after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as subscription_created or invoice_generated to verify a successful checkout.Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/checkout_existing_for_items" : { "post" : { "summary" : "Create checkout to update a subscription", "description" : "Create a Chargebee hosted page to accept payment details from a customer and checkout to update the subscription.
The following steps describe how best to use this API:
Provide item prices, coupons and a host of other details such as billing and shipping addresses to be prefilled for the customer on the checkout page. You may also provide pass_thru_content containing information and IDs from your systems that must be associated with the checkout page.
Warning\nThe first item price in the list (parameter subscription_items[item_price_id][0]) must be an item_price of item_type plan.
Send the customer to the Checkout url received in the response. They can now add a payment method or use an existing one, to complete the checkout.
The subscription is updated and the customer is redirected to the redirect_url with the id and state attributes passed as query string parameters.\nAlthough the customer will be redirected to the redirect_url after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons. Chargebee recommends listening to appropriate webhooks such as subscription_created or invoice_generated to verify a successful checkout.
Retrieve the hosted page at this stage to get the subscription and invoice details.
\ndraft status if the auto-draft conditions are met.draft status if the auto-draft conditions are met.If the billing_address attribute for the customer resource is already set, then the billing_address cannot be edited by the user during the Checkout session. To allow customers to update their billing address, use one of the following options:
openSection() function with options.sectionType set to ADDRESS to display the Customer Portal's address section.billing_address parameters.If true\nthen the existing subscription_items\nlist for the subscription is replaced by the one provided. If false\nthen the provided subscription_items\nlist gets added to the existing list.
The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices\nis set to true\n, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date.\nWhen passing this parameter, the following prerequisites must be met:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.changes_scheduled_at, reactivate_from, or trial_end.invoice_immediately is true.\n.The number of subscription billing cycles to invoice in advance.\nIf a new term is started for the subscription due to this API call, then terms_to_charge\nis inclusive of this new term. See description for the force_term_reset\nparameter to learn more about when a subscription term is reset.
If the subscription status\nis cancelled\nand it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.\nNote:\nIt is recommended not to pass this parameter along with changed_scheduled_at.\nreactivate_from\ncan be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
changes_scheduled_at cannot be earlier than 14th February.\n.If true\nthen the existing coupon_ids\nlist for the subscription is replaced by the one provided. If false\nthen the provided coupon_ids\nlist gets added to the existing list.
This parameter is only relevant for cancelled\nsubscriptions. When set to true\n, it activates the canceled subscription; otherwise, subscription changes are applied without altering its status.\nAdditionally, if not explicitly set and the subscription_items\nprovided in the API differ from the existing items, the subscription will still be reactivated.
Note: This parameter is relevant only for subscriptions with status of active, non_renewing, or cancelled.
When you set this parameter to true, the subscription term resets to the date of the subscription change.\nBy default, if you change the plan-item price to another with the same billing period, the subscription term remains unchanged. For example, if the subscription renews on the 28th of every month, it will continue to renew on the 28th after the change.
Note: If the new plan-item price has a different billing period from the current plan-item price, the subscription term resets automatically, regardless of the value of force_term_reset.
Constraints\nIf you pass force_term_reset, you must also pass invoice_usages with the same value when all of the following site configuration settings are enabled:
Specifies when the subscription change takes effect.
\nSee also
Deprecated\nThis option is deprecated; use the Create a ramp API instead.
The change is carried out at the end of the current billing cycle of the subscription.
\n* specific_date -Deprecated for scheduling changes\nThis option is deprecated for scheduling changes to occur at a future date-time, use the Create a ramp API instead.
Executes the change on a specified date. The change occurs as of the date-time defined in changes_scheduled_at.
The subscription change takes effect immediately.
", "enum" : [ "immediately", "end_of_term", "specific_date" ], "example" : null }, "changes_scheduled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The date-time at which the subscription change is to happen or has happened.
\nRequired if
change_option is set to specific_date.Deprecated for scheduling changes
Constraints
reactivate_from.Backdated changes\nchanges_scheduled_atcan be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
status is active, cancelled, or non_renewing.current_term_start.Setting this attribute to true will invoice the overages for the metered items during the subscription change.
Constraints\nIf you pass invoice_usages, you must also pass force_term_reset with the same value when all of the following site configuration settings are enabled:
The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.
\nNote :
\nredirect_url after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such as subscription_created or invoice_generated to verify a successful checkout.This attribute allows you to store custom information with the hosted_page object. You can use it to associate specific data with a hosted page session.\nFor example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the redirect URL's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.
The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status\nis future\n, in_trial\n, or cancelled.\nAlso, the value must not be earlier than changes_scheduled_at\nor start_date.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus. This parameter overrides the item_price_trial_period\ndirectly.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Determines whether the customer is e-invoiced. When set to true\nor not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (billing_address.country\n). When set to false\n, the customer is not e-invoiced even if e-invoicing is enabled for their country.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The unique identifier of the item price. The first item price in the list (subscription_items[item_price_id][0]\n) must be an item_price\nof item_type\nplan\n.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency. If changes_scheduled_at\nis in the past and a unit_price\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When price overriding\nis enabled for the site, the price or per-unit price of the item can be set here. The value set for the item price\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing\nis enabled. If changes_scheduled_at\nis in the past and a unit_price_in_decimal\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "example" : null } }, "required" : [ "item_price_id" ], "example" : null }, "discounts" : { "type" : "object", "deprecated" : false, "description" : "Parameters for discounts\n", "properties" : { "apply_on" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
The operation to be carried out for the discount.
\n\n* add -The discount is attached to the subscription.
\n* remove -The discount (given by discounts[id]\n) is removed from the subscription. Subsequent invoices will no longer have the discount applied. Tip:\nIf you want to replace a discount, remove\nit and add\nanother in the same API call.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The unique id for the entity_identifier[i]\nin Chargebee. This is required when entity_identifier[operation][i]\nis update\nor delete\n.
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The value of the entity_identifier.\nThis identifies the customer entity on the Peppol network. For example: 10101010-STO-10\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The operation to be performed for the entity_identifier\n.
Creates a new entity_identifier\nfor the customer.
Updates an existing entity_identifier\nfor the customer. entity_identifier[id]\nmust be provided in this case.
Deletes an existing entity_identifier\nfor the customer. entity_identifier[id]\nmust be provided in this case.
The standard used for specifying the entity_identifier\nscheme.\nCurrently, only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/pre_cancel" : { "post" : { "summary" : "Create a pre-cancel hosted page", "description" : "Creates a hosted_page\nresource of type\npre_cancel\n. Route canceling users to this page to provide them a retention experience and start saving revenue.\nThe hosted page is created in accordance with the retention experience configured in the Chargebee Growth app\n, along with the data provided as input to this endpoint. Call the endpoint before your customer clicks the Cancel\nbutton, and when they do, route them to the url\nin the endpoint response.
Additional data to be passed to Chargebee Growth. Only the value of pass_thru_content.custom is sent to Chargebee Growth. It is sent as the value of the custom property. The fields provided in pass_thru_content.custom must be preconfigured in Chargebee Growth.
Although only pass_thru_content.custom is sent to Chargebee Growth, all of pass_thru_content is stored by Chargebee Billing and is retrievable as an attribute of the hosted_page.\n.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/{hosted-page-id}/acknowledge" : { "post" : { "summary" : "Acknowledge a hosted page", "description" : "When a hosted page is successfully completed by the user and processed by Chargebee, its state\nis automatically changed to succeeded\n. Acknowledging a hosted page confirms that you have moved the customer details from Chargebee into your system and are ready to fulfill it. This API is used to acknowledge the hosted page in succeeded\nstate and change its state to acknowledged\n.
Note:\nThe hosted page status must be succeeded for this API call to be allowed.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/retrieve_agreement_pdf" : { "post" : { "summary" : "Retrieve Direct Debit Agreement PDF", "description" : "This is applicable only for Direct Debit via SEPA, Bacs, Bg Autogiro, BECS (for both Australia and New Zealand) and PAD. For Direct Debit, the customer needs to accept an agreement that allows the merchant to debit their bank account. This agreement PDF allows you to easily display scheme-rules compliant Direct Debit mandates to your customers.\n\nThis API retrieves the redirect link to the corresponding agreement for customers. The agreement PDF can be your \"Thank You\" page or sent by email to customers. Communicating this PDF to your customers is mandatory.\n\nCustomer locale is used to generate the PDF in the required language. If a customer language is not supported, the PDF is generated in English. Checkout the [list of languages](https://developer.gocardless.com/api-reference/#mandate-pdfs-create-a-mandate-pdf) supported by GoCardless.\n", "operationId" : "retrieve_direct_debit_agreement_pdf", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "payment_source_id" : { "type" : "string", "deprecated" : false, "description" : "Payment source to be used for this payment.\n", "maxLength" : 40, "example" : null } }, "required" : [ "payment_source_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "hosted_page" : { "$ref" : "#/components/schemas/HostedPage", "description" : "Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/{hosted-page-id}" : { "get" : { "summary" : "Retrieve a hosted page", "description" : "When you retrieve a hosted page whose status is successful, the content attribute has the following objects based on the type of the hosted page.
type of hosted page | content attribute constituents |
checkout_new |
|
checkout_existing |
|
update_payment_method |
|
pre_cancel |
|
collect_now |
|
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/manage_payment_sources" : { "post" : { "summary" : "Manage Payment Sources", "description" : "This API generates a hosted page URL to add new or update existing payment sources for the customer.\n", "operationId" : "manage_payment_sources", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "business_entity_id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "redirect_url" : { "type" : "string", "deprecated" : false, "description" : "URL to redirect after payment method is added.\n", "maxLength" : 250, "example" : null }, "customer" : { "type" : "object", "deprecated" : false, "description" : "Parameters for customer\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer.\n", "maxLength" : 50, "example" : null } }, "required" : [ "id" ], "example" : null }, "card" : { "type" : "object", "deprecated" : false, "description" : "Parameters for card\n", "properties" : { "gateway_account_id" : { "type" : "string", "deprecated" : false, "description" : "The gateway account in which this payment source is stored.\n", "maxLength" : 50, "example" : null } }, "example" : null } }, "example" : null }, "encoding" : { "card" : { "style" : "deepObject", "explode" : true }, "customer" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "hosted_page" : { "$ref" : "#/components/schemas/HostedPage", "description" : "Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/renewal_estimate" : { "get" : { "summary" : "Subscription renewal estimate", "description" : "This returns an estimate of the amount that will be charged when the subscription is billed next. The estimate is calculated based on the current recurring items of the subscription - plan, addons, and coupons.\n\nIn the response,\n\n* **estimate.subscription_estimate** has the current subscription details like its status, next billing date, and so on.\n\n**estimate.invoice_estimate**\nhas details of the invoice that will be generated at the next billing date. \nThe generated invoice estimate will include all the balances - [Promotional Credits](https://www.chargebee.com/docs/promotional-credits.html)\n, Refundable Credits, and Excess Payments - if any. If you don't want these balances to be included you can specify 'false' for the parameter *use_existing_balances*\n. \nTo exclude the [delayed charges](https://www.chargebee.com/docs/charges.html)\nfrom the invoice estimate, specify 'false' for the parameter *include_delayed_charges*\n.\n\n**Note:**\n\n* This API will not generate a renewal invoice if an [advance invoice](https://www.chargebee.com/docs/advance-invoices.html) is already present for the subscription.\n* For 'Non Renewing' subscriptions, only the [delayed charges](https://www.chargebee.com/docs/charges.html) will be included in the invoice estimate.\n* This API is not supported for 'Cancelled' subscriptions.\n* Only the subscription's charges will be included. If you have enabled the Consolidated invoicing feature, use the *Upcoming Invoices* estimate available for the Customer object to get the actual estimate invoice for the customer.\n", "operationId" : "subscription_renewal_estimate", "parameters" : [ { "name" : "include_delayed_charges", "in" : "query", "description" : "If true, all the unbilled charges will be included for the invoice estimate.\n", "required" : false, "deprecated" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "default" : true, "deprecated" : false, "example" : null } }, { "name" : "use_existing_balances", "in" : "query", "description" : "The generated invoice_estimate/next_invoice_estimate will include all the balances - Promotional Credits, Refundable Credits, and Excess Payments - if any. If you don't want these balances to be included you can specify 'false' for the parameter use_existing_balances.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/estimates/create_subscription_for_items" : { "post" : { "summary" : "Estimate for creating a customer and subscription", "description" : "Generates an estimate for creating a subscription when the customer does not exist in Chargebee. This estimate API can be called when the customer has not yet signed up and you want to preview how a new subscription would look like for them.
Note:\nEstimate operations do not make any changes in Chargebee; hence this API does not create an actual customer\nor subscription\nrecord.
The response contains one or more of the following objects:
subscription_estimate: The subscription details like the status of the subscription (such as in_trial or active), next billing date, and so on.invoice_estimate:The details of the immediate invoice, if there is one. If the subscription is created in trial/future states, invoice_estimate is unavailable as no immediate invoice is generated.next_invoice_estimate:This is returned when an immediate invoice is not generated. It contains the details of the invoice that will be generated on the next billing date of the subscription.unbilled_charge_estimates: This contains the details of charges that have not been invoiced. This is returned only if the invoice_immediately parameter is set to false.If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_immediately\nonly affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
.
", "example" : null }, "invoice_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.\ntaxes\nand\nline_item_taxes\nare computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than start_date.\nSet it to 0\nto have no trial period.
The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
\nstart_date cannot be earlier than 14th February.Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Specifies if the customer is liable for tax
\n* exempt -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.
", "enum" : [ "taxable", "exempt" ], "example" : null }, "entity_code" : { "type" : "string", "deprecated" : false, "description" : "The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)\n.\n\\* med2 -\n\nUS Medical Device Excise Tax with taxable sales tax\n\\* med1 -\n\nUS Medical Device Excise Tax with exempt sales tax\n\\* b -\n\nState government\n\\* c -\n\nTribe/Status Indian/Indian Band\n\\* a -\n\nFederal government\n\\* f -\n\nReligious organization\n\\* g -\n\nResale\n\\* d -\n\nForeign diplomat\n\\* e -\n\nCharitable or benevolent organization\n\\* j -\n\nDirect pay permit\n\\* k -\n\nDirect mail\n\\* h -\n\nCommercial agricultural production\n\\* i -\n\nIndustrial production/manufacturer\n\\* n -\n\nLocal government\n\\* l -\n\nOther or custom\n\\* m -\n\nEducational organization\n\\* r -\n\nNon-resident\n\\* p -\n\nCommercial aquaculture\n\\* q -\n\nCommercial Fishery\n", "enum" : [ "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "p", "q", "r", "med1", "med2" ], "example" : null }, "exempt_number" : { "type" : "string", "deprecated" : false, "description" : "Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)\n.\n", "maxLength" : 100, "example" : null }, "exemption_details" : { "type" : "array", "deprecated" : false, "description" : "Indicates the exemption information. You can customize customer exemption based on specific Location, Tax level (Federal, State, County and Local), Category of Tax or specific Tax Name. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\nTo know more about what values you need to provide, refer to this [Avalara's API document](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/exemption/)\n.\n", "items" : { "example" : null }, "example" : null }, "customer_type" : { "type" : "string", "deprecated" : false, "description" : "Indicates the type of the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n\\* business -\n\nWhen the purchase is made at a place of business\n\\* residential -\n\nWhen the purchase is made by a customer for home use\n\\* industrial -\n\nWhen the purchase is made by an industrial business\n\\* senior_citizen -\n\nWhen the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks\n", "enum" : [ "residential", "business", "senior_citizen", "industrial" ], "example" : null } }, "example" : null }, "contract_term" : { "type" : "object", "deprecated" : false, "description" : "Parameters for contract_term\n", "properties" : { "action_at_term_end" : { "type" : "string", "deprecated" : false, "description" : "Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency. If changes_scheduled_at\nis in the past and a unit_price\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "example" : null } }, "required" : [ "item_price_id" ], "example" : null }, "discounts" : { "type" : "object", "deprecated" : false, "description" : "Parameters for discounts\n", "properties" : { "apply_on" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/estimates/payment_schedules" : { "post" : { "summary" : "Create a payment schedule estimate", "description" : "Generates an estimate without creating a payment schedule. This endpoint can be called when you want to preview details of a new payment schedule before actually creating one.\n", "operationId" : "estimates_for_payment_schedules", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "scheme_id" : { "type" : "string", "deprecated" : false, "description" : "The unique identifier for the payment_schedule_scheme.\nThis identifier is used to retrieve the payment schedule scheme, which is then applied to calculate the amount and date for the specified number of payment schedules.
Defines the payment schedule amount set for an invoice. If this is not provided, the total invoice.amount_due\nis used. This value is mandatory in case invoice_id\nis not provided.
The date from which the payment schedule will start. This is applicable only when invoice_id is not provided. If invoice_id\nis provided, we will consider invoice.due_date\n.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/cancel_subscription_for_items_estimate" : { "post" : { "summary" : "Cancel subscription for items estimate", "description" : "Creates an estimate for [canceling](/docs/api/subscriptions/cancel-subscription-for-items) the specified subscription.\n", "operationId" : "cancel_subscription_for_items_estimate", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "cancel_option" : { "type" : "string", "deprecated" : false, "description" : "Determines when to cancel the subscription.
\nThis parameter is not applicable.
\n* end_of_billing_term -This is used to cancel a subscription either at the end of the advance term, if it's billed for future renewals or at the end of its current billing cycle
\n* end_of_term -This is used to cancel a subscription at the end of the current billing cycle
\n* immediately -This is used to cancel the subscription with immediate effect
\n* specific_date -This is used to cancel a subscription on a specified date. The change occurs as of the date/time defined in cancel_at
(Deprecated) Use cancel_option instead.\nApplicable only when the subscription does not have contract terms.\nSet this to true if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription status changes to non_renewing.
Specifies the date and time when the subscription should be canceled. Do not use this parameter when end_of_term is set to true.
Applicable only when contract_term_cancel_option is specific_date. Specifies the date and time to cancel the subscription and contract term.
You can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:
\ncurrent_term_start.cancel_at cannot be earlier than February 14.Specifies how to handle credits for current term charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle credits for current term charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
No credits notes are created.
\n* full -Credits are issues for the full value of the current term charges.
\n* prorate -Prorated credits are issued.
", "enum" : [ "none", "prorate", "full" ], "example" : null }, "unbilled_charges_option" : { "type" : "string", "deprecated" : false, "description" : "Specifies how to handle unbilled charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle unbilled charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
An invoice is generated immediately with the unbilled charges.
\n* delete -The unbilled charges are deleted.
", "enum" : [ "invoice", "delete" ], "example" : null }, "account_receivables_handling" : { "type" : "string", "deprecated" : false, "description" : "Specifies how to handle past due invoices when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle past due invoices when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
No action is taken.
\n* write_off -Applies excess payments and refundable credits to past due invoices. Any remaining balance is written off.\nNote: The credit note for the write-off is not included in the API response.
\n* schedule_payment_collection -Applies excess payments and refundable credits to past due invoices. If any amount remains and auto_collection\nis on\n, the remaining amount is automatically charged to the available payment method.
Specifies how to handle refundable credits when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle refundable credits when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
Refunds remaining credits after applying them to any past due invoices.
\n* no_action -No action is taken.
", "enum" : [ "no_action", "schedule_refund" ], "example" : null }, "contract_term_cancel_option" : { "type" : "string", "deprecated" : false, "description" : "Required when the subscription has a contract term. Determines when to cancel the subscription along with the contract term.
\n* terminate_immediately -Cancels the subscription and contract term immediately. Sets the contract term's status to terminated and collects any termination fee, if applicable.\nTo specify the termination fee, include a single object in the subscription_items array. If not specified, the default termination fee is applied (if configured).
Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term.
\n* specific_date -Cancels the subscription and contract term on the date specified by cancel_at. Sets action_at_term_end to cancel.\nNote: Contact Chargebee Support to enable this option for your Chargebee site.
Cancels the subscription and contract term at the end of the current billing cycle. Sets action_at_term_end to cancel.\nNote: Contact Chargebee Support to enable this option for your Chargebee site.
The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices\nis true\n, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes\nand line_item_taxes\nare computed based on the tax\nconfiguration as of invoice_date.\nWhen passing this parameter, the following prerequisites must be met:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.cancel_at.\n.The unique id\nof the charge item_price that represents the termination fee.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/resume_subscription_estimate" : { "post" : { "summary" : "Resume subscription estimate", "description" : "Generates an estimate for the 'resume subscription' operation. This is similar to the [Resume a subscription](/docs/api/subscriptions/resume-a-subscription) API, but the subscription will not be resumed. Only an estimate for this operation is created.\n\nIn the response,\n\n* **estimate.subscription_estimate** has the subscription details.\n\n**estimate.invoice_estimate**\nhas details of the invoice that will be generated immediately. This will not be present if no immediate invoice is generated for this operation. This will happen for in-term resumption++\n. \n**++What is an \"in-term resumption\"?**\n\nAn \"in-term resumption\" is when the resumption happens within the billing term of the subscription.\n\n**estimate.next_invoice_estimate**\nhas details of the invoice that will be generated during the next billing date of this subscription. This will be present only if no immediate invoice is generated during this operation (scenario mentioned above) and this subscription has next billing. \nThe generated invoice_estimate/next_invoice_estimate will include all the balances - [Promotional Credits](https://www.chargebee.com/docs/promotional-credits.html)\n, Refundable Credits, and Excess Payments - if any.\n", "operationId" : "resume_subscription_estimate", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "resume_option" : { "type" : "string", "deprecated" : false, "description" : "List of options to resume the subscription.\n\\* immediately -\n\nResume immediately\n\\* specific_date -\n\nResume on a specific date\n", "enum" : [ "immediately", "specific_date" ], "example" : null }, "charges_handling" : { "type" : "string", "deprecated" : false, "description" : "Applicable when charges get added during this operation and **resume_option**\nis set as 'immediately'. Allows to raise invoice immediately or add them to unbilled charges.\n\\* add_to_unbilled_charges -\n\nAdd to unbilled charges\n\\* invoice_immediately -\n\nInvoice immediately\n", "enum" : [ "invoice_immediately", "add_to_unbilled_charges" ], "example" : null }, "subscription" : { "type" : "object", "deprecated" : false, "description" : "Parameters for subscription\n", "properties" : { "resume_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.\n", "example" : null } }, "example" : null } }, "example" : null }, "encoding" : { "subscription" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", "description" : "Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/estimates/create_invoice_for_items" : { "post" : { "summary" : "Create invoice for items estimate", "description" : "This endpoint creates an invoice estimate for non-recurring items.\n", "operationId" : "create_invoice_for_items_estimate", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "currency_code" : { "type" : "string", "deprecated" : false, "description" : "The currency code (ISO 4217 format) of the invoice amount.\n", "maxLength" : 3, "example" : null }, "invoice_note" : { "type" : "string", "deprecated" : false, "description" : "A note for this particular invoice. This, and [all other notes](/docs/api/invoices/invoice-object#notes)\nfor the invoice are displayed on the PDF invoice sent to the customer.\n", "maxLength" : 2000, "example" : null }, "remove_general_note" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Set as true\nto remove the general note\nfrom this invoice.
The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.\ntaxes\nand\nline_item_taxes\nare computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The price or per-unit-price of the item price. By default, it is the value set\nfor the item_price.\nThis is only applicable when the pricing_model\nof the item_price\nis flat_fee\nor per_unit.\nThe value depends on the type of currency\n.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Type of entity to which the note\nbelongs. To remove the general note, use the remove_general_note\nparameter.
Entity that represents an addon.
\n* addon_item_price -Indicates that this line item is based on addon Item Price
\n* charge_item_price -Indicates that this line item is based on charge Item Price
\n* plan -Entity that represents a plan.
\n* plan_item_price -Indicates that this line item is based on plan Item Price
\n* customer -Entity that represents a customer.
\n* subscription -Entity that represents a subscription of customer.
\n* coupon -Entity that represents a coupon.
", "enum" : [ "customer", "subscription", "coupon", "plan_item_price", "addon_item_price", "charge_item_price" ], "example" : null }, "example" : null }, "entity_id" : { "type" : "array", "description" : "Unique identifier of the [note](/docs/api/invoices/invoice-object#notes)\n.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null } }, "example" : null }, "discounts" : { "type" : "object", "deprecated" : false, "description" : "Parameters for discounts\n", "properties" : { "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "quantity" : { "type" : "array", "description" : "Specifies the number of free units provided for the item, without affecting the total quantity sold\n", "items" : { "type" : "integer", "format" : "int32", "deprecated" : false, "minimum" : 1, "example" : null }, "example" : null }, "apply_on" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/estimates/gift_subscription_for_items" : { "post" : { "summary" : "Gift subscription estimate for items", "description" : "This endpoint generates an estimate for a subscription that is intended to be a gift. The estimate provides details about the gift sender, gift recipient, address details of the recipient, and the type and details of subscription items included in the gift.\n", "operationId" : "gift_subscription_estimate_for_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "coupon_ids" : { "type" : "array", "deprecated" : false, "description" : "List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "gift" : { "type" : "object", "deprecated" : false, "description" : "Parameters for gift\n", "properties" : { "scheduled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.\n", "example" : null }, "auto_claim" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "When true\n, the claim happens automatically. When not passed, the default value in the site settings is used.
When true\n, indicates that the gift does not expire. Do not pass or pass as false\nwhen auto_claim\nis set.
The date until which the gift can be claimed. Must be set to a value after scheduled_at.\nIf the gift is not claimed within claim_expiry_date\n, it will expire and the subscription will move to cancelled\nstate. When not passed, the value specified in the site settings will be used.\nPass as NULL\nor do not pass when auto_claim\nor no_expiry\nare set.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_of_residence: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a two-character ISO code.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The price/per unit price of the item. The value is interpreted as per the type of currency.
\nPrerequisites
pricing_model of the item price is flat_fee or per_unit.Default value
item_price.price.The price/per unit price of the item in major units of the currency. When not provided, the value set for the item price is used.
\nPrerequisites
pricing_model of the item price is flat_fee or per_unit.Default value
The lowest value in the quantity tier.
\nConstraints
ending_unit of the next lower tier.The highest value in the quantity tier.
\nConstraints
starting_unit of the next higher tier.The decimal representation of the lowest value of quantity in this tier.
\nConstraints
ending_unit_in_decimal of the next lower tier.Prerequisite
The decimal representation of the highest value of quantity in this tier.
\nConstraints
starting_unit_in_decimal of the next higher tier.Prerequisite
tiered or volume.stairstep.Constraints
Prerequisite
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/estimates/update_subscription_for_items" : { "post" : { "summary" : "Estimate for updating a subscription", "description" : "Returns an estimate for updating a subscription.
In the response,
subscription_estimate: The details of the changed subscription such as status, next billing date, and so on.invoice_estimate:The details of the immediate invoice, if it is generated. An immediate invoice is not generated when:\nend_of_term parameter is trueprorate parameter is falsesubscription_items.next_invoice_estimate:The details of the invoice to be generated later (if any) on the occasion that no immediate invoice has been generated.credit_note_estimates:The list of credit notes (if any) generated during this operation.unbilled_charge_estimates: The details of charges that have not been invoiced. This is returned only if the invoice_immediately parameter is set to false.The following conditions must be met or tax calculation is ignored:
taxability attribute for the customer is true.billing_address, shipping_address, customer[vat_number]When change_option is set to specific_date, then set the date/time at which the subscription change is to happen or has happened.
Constraints
reactivate_from.changes_scheduled_at parameter does not apply to auto_collection, shipping_address, and po_number; these parameters take effect immediately when scheduling a subscription update.Backdated changes\nchanges_scheduled_atcan be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
status is active, cancelled, or non_renewing.current_term_start.changes_scheduled_at cannot be earlier than 14th February.Specifies the effective date for the subscription change.
\n* end_of_term -The change is carried out at the end of the current billing cycle of the subscription.
\n* specific_date -Executes the change on a specified date. The change occurs as of the date/time defined in changes_scheduled_at.
The change is carried out immediately.
", "enum" : [ "immediately", "end_of_term", "specific_date" ], "example" : null }, "mandatory_items_to_remove" : { "type" : "array", "deprecated" : false, "description" : "Item ids of [mandatorily attached addons](/docs/api/attached_items)\nthat are to be removed from the subscription.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "replace_items_list" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "If true\nthen the existing subscription_items\nlist for the subscription is replaced by the one provided. If false\nthen the provided subscription_items\nlist gets added to the existing list.
The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices\nis set to true\n, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date.\nWhen passing this parameter, the following prerequisites must be met:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.changes_scheduled_at, reactivate_from, or trial_end.invoice_immediately is true.\n.The number of subscription billing cycles to invoice in advance.\nIf a new term is started for the subscription due to this API call, then terms_to_charge\nis inclusive of this new term. See description for the force_term_reset\nparameter to learn more about when a subscription term is reset.
If the subscription status\nis cancelled\nand it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.\nNote:\nIt is recommended not to pass this parameter along with changed_scheduled_at.\nreactivate_from\ncan be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
changes_scheduled_at cannot be earlier than 14th February.\n.If true\nthen the existing coupon_ids\nlist for the subscription is replaced by the one provided. If false\nthen the provided list gets added to the existing coupon_ids\n.
true: Prorated credits or charges are created as applicable for this change.false: The subscription is changed without creating any credits or charges.Caveat
For further changes within the same billing term, when prorate is set to true, credits are not created when all the conditions below hold true:
An immediate previous change was made
prorate set to false andDeprecated
change_option instead.change_option, then change_option wins.Set this to true if you want the update to be applied at the end of the current subscription billing cycle.
", "example" : null }, "force_term_reset" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Say the subscription has the renewal date as 28th of every month. When the plan-item price of the subscription is set to one that has the same billing period as the current plan-item price, the subscription change does not change the term. In other words, the subscription still renews on the 28th. Passing this parameter as true\nwill have the subscription reset its term to the current date (provided end_of_term\nis false).\nNote:\nWhen the new plan-item price has a billing period different from the current plan-item price of the subscription, the term is always reset, regardless of the value passed for this parameter.
Applicable only for cancelled\nsubscriptions. When passed as true\n, the canceled subscription is activated; otherwise subscription changes are made without changing its status.\nIf not passed, subscription will be activated only if subscription_items\nis passed.
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_immediately\nonly affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
.
", "example" : null }, "invoice_usages" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Setting this attribute to true will invoice the overages for the metered item during subscription changes\n.
The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.
The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status\nis future\n, in_trial\n, or cancelled.\nAlso, the value must not be earlier than changes_scheduled_at\nor start_date.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Maximum amount of excess payments\nthat can be applied to any single invoice associated with this subscription. Set to -1 to auto-apply without limit, 0 to prevent auto-application, or any positive value to define the maximum amount that can be applied.
Maximum amount of refundable credits\nthat can be applied to any single invoice associated with this subscription. Set to -1 to auto-apply without limit, 0 to prevent auto-application, or any positive value to define the maximum amount that can be applied.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency. If changes_scheduled_at\nis in the past and a unit_price\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When price overriding\nis enabled for the site, the price or per-unit price of the item can be set here. The value set for the item price\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing\nis enabled. If changes_scheduled_at\nis in the past and a unit_price_in_decimal\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "example" : null }, "proration_type" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "Note\nApplicable only for item prices with:
item_type = addon.pricing_model = per_unit.Specifies how to manage charges or credits for the addon item price for this subscription update estimate. You may use this parameter only if the change to the subscription takes effect immediately.
Note:\nIf you don't provide a value, Chargebee determines the proration logic based on the following precedence: this parameter > prorate\nparameter > item_price.proration_type
\nsite-wide proration\nsetting.
\n
Don't apply any charges or credits for the addon.
\n* partial_term -Prorate the charges or credits for the rest of the current term.
\n* full_term -Charge the full price of the addon or give the full credit. Don't apply any proration.
", "enum" : [ "full_term", "partial_term", "none" ], "example" : null }, "example" : null } }, "required" : [ "item_price_id" ], "example" : null }, "discounts" : { "type" : "object", "deprecated" : false, "description" : "Parameters for discounts\n", "properties" : { "apply_on" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
The operation to be carried out for the discount.
\n\n* add -The discount is attached to the subscription.
\n* remove -The discount (given by discounts[id]\n) is removed from the subscription. Subsequent invoices will no longer have the discount applied. Tip:\nIf you want to replace a discount, remove\nit and add\nanother in the same API call.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/upcoming_invoices_estimate" : { "get" : { "summary" : "Upcoming invoices estimate", "description" : "Estimate of the upcoming scheduled invoices (subscription activations, renewals etc) of a customer. For now preview of the invoices generated on the immediate upcoming date is supported. Say a customer has couple of subscription renewals scheduled on *Jan,10th* and another subscription renewal scheduled on *Jan,15th* . This API gives the preview of all the invoices scheduled to be generated on *Jan,10th* (immediate upcoming date).\n\nIn the response:\n\n* **estimate.invoice_estimates\\[\\]** has details of the invoices scheduled to be generated.\n\n**Note:** If *consolidated invoicing* is enabled you may use this API to test whether upcoming renewals are consolidated.\n", "operationId" : "upcoming_invoices_estimate", "parameters" : [ { "name" : "include_usage_charges", "in" : "query", "description" : "When set to true, the invoice_estimates[] returned in the response includes usage-based line items, if any. These are invoice_estimates[].line_items[] where line_items[].metered is true.
See also:
\nPricing for usage-based line items.Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/regenerate_invoice_estimate" : { "post" : { "summary" : "Regenerate Invoice Estimate", "description" : "Regenerates the invoice for the current term of the subscription. The subscription must have status as active or non_renewing. This operation is not allowed when any of the following conditions hold true for the subscription:
status is not voided.Returns an estimate object with one of the following components depending on the value of invoice_immediately.
true: an invoice_estimate object that corresponds to the regenerated invoice.false: a list of unbilled_charge_estimate objects corresponding to all the unbilled charges created for the current term of the subscription.Whether the charges should be prorated according to the term specified by date_from\nand date_to.\nShould not be passed without date_from\nand date_to\n.
Only applicable when Consolidated Invoicing\nis enabled for the customer. Set to false\nto leave the current term charge for the subscription as unbilled.\nOnce you have done this for all suitable subscriptions of the customer, call Create an invoice for unbilled charges\nto invoice them.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/create_subscription_for_items_estimate" : { "post" : { "summary" : "Estimate for creating a subscription", "description" : "Generates an estimate without creating a subscription. This endpoint can be called when you want to preview details of a new subscription before actually creating one.
The following conditions must be met or tax calculation is ignored:
taxability attribute for the customer is true.shipping_address is passed when needed for tax calculation.If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_immediately\nonly affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
.
", "example" : null }, "billing_cycles" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles [set for the plan-item price](/docs/api/item_prices/item_price-object#billing_cycles)\nis used.\n", "minimum" : 0, "example" : null }, "mandatory_items_to_remove" : { "type" : "array", "deprecated" : false, "description" : "Item ids of [mandatorily attached addons](/docs/api/attached_items)\nthat are to be removed from the subscription.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "terms_to_charge" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html)\n.\n", "minimum" : 1, "example" : null }, "billing_alignment_mode" : { "type" : "string", "deprecated" : false, "description" : "Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)\nfor Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.\n\\* immediate -\n\nSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n\\* delayed -\n\nSubscription period will be aligned with the configured billing date at the next renewal.\n", "enum" : [ "immediate", "delayed" ], "example" : null }, "invoice_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date.\ntaxes\nand\nline_item_taxes\nare computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than start_date.\nSet it to 0\nto have no trial period.
The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
\nstart_date cannot be earlier than 14th February.Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
Maximum amount of excess payments\nthat can be applied to any single invoice associated with this subscription. Set to -1 to auto-apply without limit, 0 to prevent auto-application, or any positive value to define the maximum amount that can be applied.
Maximum amount of refundable credits\nthat can be applied to any single invoice associated with this subscription. Set to -1 to auto-apply without limit, 0 to prevent auto-application, or any positive value to define the maximum amount that can be applied.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency. If changes_scheduled_at\nis in the past and a unit_price\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "example" : null } }, "required" : [ "item_price_id" ], "example" : null }, "discounts" : { "type" : "object", "deprecated" : false, "description" : "Parameters for discounts\n", "properties" : { "apply_on" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/change_term_end_estimate" : { "post" : { "summary" : "Subscription change term end estimate", "description" : "Generates an estimate for the 'change term end' operation. This is similar to the [Change term end](/docs/api/subscriptions/change-term-end) API but the subscription's term end will not be changed, only an estimate for this operation is created. This is applicable only for subscriptions in 'in-trial', 'active' and 'non-renewing' states.\n\nIn the response,\n\n* **estimate.subscription_estimate** has the subscription details like the status of the subscription (in_trial, active, etc.), next billing date, and so on.\n* **estimate.invoice_estimate** has details of the invoice that will be generated immediately. This will not be present if no immediate invoice is generated for this operation. This will happen when\n * *prorate* parameter is false, or\n * *invoice_immediately* parameter is false, or\n * subscription is in *in-trial* state\n* **estimate.credit_note_estimates\\[\\]** has details of the credit-notes that will get generated during this operation. This list will be empty if no credit-note gets generated during this operation.\n* **estimate.unbilled_charge_estimates\\[\\]** has details of the unbilled charges. This is returned only if *invoice_immediately* is set as false.\n", "operationId" : "subscription_change_term_end_estimate", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "term_ends_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time at which the current term should end for this subscription.\n", "example" : null }, "prorate" : { "type" : "boolean", "deprecated" : false, "description" : "Applicable for *active*\n/ *non_renewing*\nsubscriptions. If specified as *true*\nprorated charges / credits will be added during this operation.\n", "example" : null }, "invoice_immediately" : { "type" : "boolean", "deprecated" : false, "description" : "If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_immediately\nonly affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
.
", "example" : null } }, "required" : [ "term_ends_at" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", "description" : "Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/pause_subscription_estimate" : { "post" : { "summary" : "Pause subscription estimate", "description" : "This API provides an estimate of the details pertaining to the pause_subscription operation. It returns attributes such as pause_date and resume_date. This is similar to the Pause a subscription API with the exception that the subscription is not paused. Only an estimate for this operation is created.
In the response,
List of options to pause the subscription.
\n* billing_cycles -Pause at the end of the current term, and resume automatically after the number of billing cycles you specify in skip_billing_cycles
Pause immediately
\n* end_of_term -Pause at the end of current term
\n* specific_date -Pause on a specific date
", "enum" : [ "immediately", "end_of_term", "specific_date", "billing_cycles" ], "example" : null }, "unbilled_charges_handling" : { "type" : "string", "deprecated" : false, "description" : "Applicable when unbilled charges are present for the subscription and pause_option is set as immediately. Note: On the invoice raised, an automatic charge is attempted on the payment method available, if customer's auto-collection property is set to on.
Invoice charges\nIf invoice is chosen, an automatic charge is attempted on the payment method available if the customer has enabled auto-collection. If a payment collection fails or when auto-collection is not enabled, the invoice is closed as unpaid.
Retain as unbilled\nIf no_action is chosen, charges are added to the resumption invoice.
When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the paused\nstate, it is the date/time when the subscription was paused.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/advance_invoice_estimate" : { "post" : { "summary" : "Advance invoice estimate", "description" : "This API is used to generate an invoice estimate for preview. Estimate details include the number of billing cycles to be invoiced in advance, the number of billing cycles in one interval, advance invoicing schedules, and so on.\n", "operationId" : "advance_invoice_estimate", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "terms_to_charge" : { "type" : "integer", "format" : "int32", "default" : 1, "deprecated" : false, "description" : "schedule_type = immediate: the number of future billing cycles to be invoiced in advance. The invoicing is done for the remaining_billing_cycles of the subscription if that is less than terms_to_charge.schedule_type = fixed_intervals: The number of future billing cycles in one interval. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles of the subscription.\n.Whether the charge should be invoiced immediately or added to unbilled_charges.\nApplicable only when schedule_type\nis immediate\n.
The type of advance invoice or advance invoicing schedule.
\n* immediate -Charge immediately for the number of billing cycles specified by terms_to_charge\n.
Charge on specific dates.\nFor each date, specify the number of billing cycles\nto charge for. Up to 5 dates can be configured.
\n* fixed_intervals -Charge at fixed intervals of time. Specify the number of billing cycles\nthat constitute an interval and the number of days before each interval\nthat the invoice should be generated. Also specify when the schedule should end\n.
", "enum" : [ "immediate", "specific_dates", "fixed_intervals" ], "example" : null }, "fixed_interval_schedule" : { "type" : "object", "deprecated" : false, "description" : "Parameters for fixed_interval_schedule\n", "properties" : { "number_of_occurrences" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles\nof the subscription. This parameter is applicable only when fixed_interval_schedule[end_schedule_on]\n= after_number_of_intervals
Specifies when the schedule should end.
\n* after_number_of_intervals -Advance invoices are generated a specified number of times
Advance invoices are generated for as long as the subscription is active.
\n* specific_date -End the advance invoicing schedule on a specific date\n.
The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when fixed_interval_schedule[end_schedule_on]\n= specific_date\n.
The number of billing cycles to charge for, on the date specified. Applicable only when schedule_type\nis specific_dates.
The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when schedule_type\nis specific_dates\n.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/create_subscription_quote_for_items" : { "post" : { "summary" : "Create a quote for subscription creation", "description" : "Create a quote for new subscription line items of a customer.\n", "operationId" : "create_a_quote_for_a_new_subscription_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "customer-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/customer-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "name" : { "type" : "string", "deprecated" : false, "description" : "The quote name will be used as the pdf name of the quote.\n", "maxLength" : 100, "example" : null }, "notes" : { "type" : "string", "deprecated" : false, "description" : "Notes specific to this quote that you want customers to see on the quote PDF.\n", "maxLength" : 10000, "example" : null }, "expires_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Quotes will be valid till this date. After this quote will be marked as closed.\n", "example" : null }, "billing_cycles" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles [set for the plan-item price](/docs/api/item_prices/item_price-object#billing_cycles)\nis used.\n", "minimum" : 0, "example" : null }, "mandatory_items_to_remove" : { "type" : "array", "deprecated" : false, "description" : "Item ids of [mandatorily attached addons](/docs/api/attached_items)\nthat are to be removed from the subscription.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "terms_to_charge" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html)\n.\n", "minimum" : 1, "example" : null }, "billing_alignment_mode" : { "type" : "string", "deprecated" : false, "description" : "Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)\nfor Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.\n\\* immediate -\n\nSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n\\* delayed -\n\nSubscription period will be aligned with the configured billing date at the next renewal.\n", "enum" : [ "immediate", "delayed" ], "example" : null }, "coupon_ids" : { "type" : "array", "deprecated" : false, "description" : "The list of IDs of the coupons to be applied. Coupon codes are also supported.
\nNote
Not applicable when Chargebee CPQ is enabled. Use coupons[] array instead.
The number of days from invoice.date until payment for the invoice is due.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than start_date.\nSet it to 0\nto have no trial period.
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately on quote conversion. The quote can be converted on a date/time after this date. This is called backdating the subscription creation and is done when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:
\nsubscription[start_date] cannot be earlier than 14th February.Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The period of time by which the first term of the subscription is extended free of charge. The value is expressed in the time unit specified by free_period_unit. For example, 3 with free_period_unit = month adds 3 free months to the first term of the subscription.
Prerequisite
\nCan be used only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.The time unit for free_period.
Prerequisite
\nCan be used only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.\nConstraint
\nMust be equal to or lower than theperiod_unit of the plan item price of the subscription.Charge based on year(s)
\n* day -Charge based on day(s)
\n* month -Charge based on month(s)
\n* week -Charge based on week(s)
", "enum" : [ "day", "week", "month", "year" ], "example" : null } }, "example" : null }, "shipping_address" : { "type" : "object", "deprecated" : false, "description" : "Parameters for shipping_address\n", "properties" : { "first_name" : { "type" : "string", "deprecated" : false, "description" : "The first name of the contact.\n", "maxLength" : 150, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "The last name of the contact.\n", "maxLength" : 150, "example" : null }, "email" : { "type" : "string", "format" : "email", "deprecated" : false, "description" : "The email address.\n", "maxLength" : 70, "example" : null }, "company" : { "type" : "string", "deprecated" : false, "description" : "The company name.\n", "maxLength" : 250, "example" : null }, "phone" : { "type" : "string", "deprecated" : false, "description" : "The phone number.\n", "maxLength" : 50, "example" : null }, "line1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1\n", "maxLength" : 150, "example" : null }, "line2" : { "type" : "string", "deprecated" : false, "description" : "Address line 2\n", "maxLength" : 150, "example" : null }, "line3" : { "type" : "string", "deprecated" : false, "description" : "Address line 3\n", "maxLength" : 150, "example" : null }, "city" : { "type" : "string", "deprecated" : false, "description" : "The name of the city.\n", "maxLength" : 50, "example" : null }, "state_code" : { "type" : "string", "deprecated" : false, "description" : "The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The first name of the billing contact.
\nNote
The parameter billing_address and all its sub-parameters apply only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency. If changes_scheduled_at\nis in the past and a unit_price\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "example" : null }, "start_date" : { "type" : "array", "description" : "Specifies the start date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The index or identifier of the ramp to which the item price belongs. Use this index to map item_tier values to the correct ramp, as the target item_price of an item_tier may be part of multiple ramps.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The amount on the quote to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Specifies the start date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The index or identifier of the ramp to which this tier information belongs. This must be a value from the subscription_items[ramp_tier_id][i]. Since an item price can be part of multiple subscriptions ramps, this group ID specifies the ramp to which this tier information belongs.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the start date for the coupon. The period of the coupon, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the coupon. The period of the coupon, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "Resource object representing quoted_ramp
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}" : { "get" : { "summary" : "Retrieve a quote", "description" : "Retrieves the quotes identified by the 'number' specified in the url.\n", "operationId" : "retrieve_a_quote", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "quote-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/quote-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "quote" : { "$ref" : "#/components/schemas/Quote", "description" : "Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "Resource object representing quoted_ramp
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/update_status" : { "post" : { "summary" : "Update quote status", "description" : "Updates the status of the quote.\n", "operationId" : "update_quote_status", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "quote-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/quote-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "status" : { "type" : "string", "deprecated" : false, "description" : "The status to which the quote should be updated.\n\\* accepted -\n\nThe customer has accepted the quote.\n\\* closed -\n\nThe quote has been marked as closed. \n**Note**\n\nNot applicable when Chargebee CPQ is enabled.\n\\* declined -\n\nThe customer declined/rejected the quote.\n\\* open -\n\nThe quote is either newly created, or has been approved but not yet sent to the customer.\n\\* proposed -\n\nThe quote has been shared with the customer via email or e-signature and is awaiting their response. \n**Note**\n\nApplicable only when Chargebee CPQ is enabled. To request access, contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support).\n\\* voided -\n\nThe quote has been invalidated and can no longer be acted upon. \n**Note**\n\nApplicable only when Chargebee CPQ is enabled. To request access, contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support).\n", "enum" : [ "accepted", "declined", "proposed", "voided", "closed" ], "example" : null }, "comment" : { "type" : "string", "deprecated" : false, "description" : "An internal [comment](/docs/api/comments)\nto be added for this operation, to the quote. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing [Hosted Page](/docs/api/hosted_pages)\nor any document such as the [Quote PDF](/docs/api/quotes/retrieve-quote-as-pdf)\n.\n", "maxLength" : 300, "example" : null } }, "required" : [ "status" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "quote" : { "$ref" : "#/components/schemas/Quote", "description" : "Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "Resource object representing quoted_ramp
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/extend_expiry_date" : { "post" : { "summary" : "Extend expiry date", "description" : "Can be used to extend the expiry date of a quote.\n", "operationId" : "extend_expiry_date", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "quote-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/quote-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "valid_till" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Quote will be valid till this date. After this date quote will be marked as closed.\n", "example" : null } }, "required" : [ "valid_till" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "quote" : { "$ref" : "#/components/schemas/Quote", "description" : "Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "Resource object representing quoted_ramp
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/edit_update_subscription_quote_for_items" : { "post" : { "summary" : "Edit a quote for subscription update", "description" : "Edits a quote for updating a subscription.
If the quote is for a scheduled change, then the following resources are updated:
quote and the quoted_subscription are updated.quote, the quoted_ramp, and the quoted_subscription are updated.For more details, see Ramps API compatibility mode.
If true\nthen the existing subscription_items\nlist for the subscription is replaced by the one provided. If false\nthen the provided subscription_items\nlist gets added to the existing list.
The number of subscription billing cycles to invoice in advance.\nIf a new term is started for the subscription due to this API call, then terms_to_charge\nis inclusive of this new term. See description for the force_term_reset\nparameter to learn more about when a subscription term is reset.
If the subscription status\nis cancelled\nand it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.\nNote:\nIt is recommended not to pass this parameter along with changed_scheduled_at.\nreactivate_from\ncan be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
changes_scheduled_at cannot be earlier than 14th February.\n.The list of IDs of the coupons to be applied. Coupon codes are also supported.
\nNote
Not applicable when Chargebee CPQ is enabled. Use coupons[] array instead.
When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
\n* end_of_term -The change is carried out at the end of the current billing cycle of the subscription.
\n* specific_date -The change is carried out as of the date specified under changes_scheduled_at\n.
The change is carried out immediately.
", "enum" : [ "immediately", "specific_date" ], "example" : null }, "changes_scheduled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "When change_option is set to specific_date, then set the date-time at which the subscription change is to happen or has happened.
Constraints
reactivate_from.changes_scheduled_at parameter does not apply to auto_collection, shipping_address, and po_number; these parameters take effect immediately when scheduling a subscription update.Backdated changes\nchanges_scheduled_atcan be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
status is active, cancelled, or non_renewing.current_term_start.The number of days from invoice.date until payment for the invoice is due.
Note\nThe parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.
The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status\nis future\n, in_trial\n, or cancelled.\nAlso, the value must not be earlier than changes_scheduled_at\nor start_date.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The first name of the billing contact.
\nNote\nThe parameter billing_address and all its sub-parameters apply only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency. If changes_scheduled_at\nis in the past and a unit_price\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When price overriding\nis enabled for the site, the price or per-unit price of the item can be set here. The value set for the item price\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing\nis enabled. If changes_scheduled_at\nis in the past and a unit_price_in_decimal\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "example" : null }, "start_date" : { "type" : "array", "description" : "Specifies the start date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The index or identifier of the ramp to which the item price belongs. Use this index to map item_tier values to the correct ramp, as the target item_price of an item_tier may be part of multiple ramps.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The amount on the quote to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
The operation to be carried out for the discount.
\n\n* add -The discount is attached to the subscription.
\n* remove -The discount (given by discounts[id]\n) is removed from the subscription. Subsequent invoices will no longer have the discount applied. Tip:\nIf you want to replace a discount, remove\nit and add\nanother in the same API call.
The id of the discount to be removed. This parameter is only relevant when discounts[operation_type]\nis remove.
Specifies the start date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The index or identifier of the ramp to which this tier information belongs. This must be a value from the subscription_items[ramp_tier_id][i]. Since an item price can be part of multiple subscriptions ramps, this group ID specifies the ramp to which this tier information belongs.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the start date for the coupon. The period of the coupon, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the coupon. The period of the coupon, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "Resource object representing quoted_ramp
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes" : { "get" : { "summary" : "List quotes", "description" : "List all quotes.\n", "operationId" : "list_quotes", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
The document date displayed on the invoice PDF. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. When not provided, the value is the same as current date. Moreover, if the invoice is created as pending\n, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes\nand line_item_taxes\nare computed based on the tax configuration as of invoice_date.\nWhen passing this parameter, the following prerequisites must be met:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.quoted_subscription.start_date or quoted_subscription.changes_scheduled_at (whichever is applicable).invoice_immediately must be true.\n.If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_immediately\nonly affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
.
", "example" : null }, "create_pending_invoices" : { "type" : "boolean", "deprecated" : false, "description" : "This attribute is set to true\nautomatically for the subscription when it has one or more metered\nitems. However, when there are no metered\nitems, you can pass this parameter as true\nto force all invoices (except the first) to be created as pending.\nThis is useful in the following scenarios:
Note:
pending, pass first_invoice_pending as true..
", "example" : null }, "first_invoice_pending" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "Non-metered items are billed at the beginning of a billing cycle while metered items are billed at the end. Consequently, the first invoice of the subscription contains only the non-metered items.
\nBy passing this parameter as true, you create the first invoice as pending allowing you to add the previous term's metered charges to it before closing. This is useful when the subscription is moved to Chargebee from a different billing system. As applicable to all pending invoices, this invoice is also closed automatically or via an API call.
Note:
This parameter is passed only when there are metered items in the subscription or when create_pending_invoices is true.
.
", "example" : null }, "subscription" : { "type" : "object", "deprecated" : false, "description" : "Parameters for subscription\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Applicable only for create subscription quote.\n", "maxLength" : 50, "example" : null }, "auto_collection" : { "type" : "string", "deprecated" : false, "description" : "Applicable only for create subscription quote.\n\\* off -\n\nAutomatic collection of charges will not be made for this subscription. Use this for offline payments.\n\\* on -\n\nWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n", "enum" : [ "on", "off" ], "example" : null }, "po_number" : { "type" : "string", "deprecated" : false, "description" : "Purchase order number for this subscription.\n", "maxLength" : 100, "example" : null }, "auto_close_invoices" : { "type" : "boolean", "deprecated" : false, "description" : "When auto-closing of invoices\nis enabled for the site, you can pass this parameter as false\nto prevent the automatic closing of invoices for this subscription. The value passed here takes precedence over the value stored at the customer level\n.
Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "Resource object representing quoted_ramp
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "customer", "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/delete" : { "post" : { "summary" : "Delete a quote", "description" : "Delete a quote using this API.\n", "operationId" : "delete_a_quote", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "quote-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/quote-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "comment" : { "type" : "string", "deprecated" : false, "description" : "Reason for deleting this transaction. This comment will be added to the associated entity.\n", "maxLength" : 300, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "quote" : { "$ref" : "#/components/schemas/Quote", "description" : "Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "Resource object representing quoted_ramp
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/edit_create_subscription_quote_for_items" : { "post" : { "summary" : "Edit a quote for subscription creation", "description" : "Changes the quote produced for creating a new subscription items\n", "operationId" : "edit_create_subscription_quote_for_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "quote-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/quote-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "notes" : { "type" : "string", "deprecated" : false, "description" : "Notes specific to this quote that you want customers to see on the quote PDF.\n", "maxLength" : 10000, "example" : null }, "expires_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Quotes will be valid till this date. After this quote will be marked as closed.\n", "example" : null }, "billing_cycles" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles [set for the plan-item price](/docs/api/item_prices/item_price-object#billing_cycles)\nis used.\n", "minimum" : 0, "example" : null }, "mandatory_items_to_remove" : { "type" : "array", "deprecated" : false, "description" : "Item ids of [mandatorily attached addons](/docs/api/attached_items)\nthat are to be removed from the subscription.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "terms_to_charge" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html)\n.\n", "minimum" : 1, "example" : null }, "billing_alignment_mode" : { "type" : "string", "deprecated" : false, "description" : "Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)\nfor Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.\n\\* immediate -\n\nSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n\\* delayed -\n\nSubscription period will be aligned with the configured billing date at the next renewal.\n", "enum" : [ "immediate", "delayed" ], "example" : null }, "coupon_ids" : { "type" : "array", "deprecated" : false, "description" : "The list of IDs of the coupons to be applied. Coupon codes are also supported.
\nNote
Not applicable when Chargebee CPQ is enabled. Use coupons[] array instead.
The number of days from invoice.date until payment for the invoice is due.
Note\nThe parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than start_date.\nSet it to 0\nto have no trial period.
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately on quote conversion. The quote can be converted on a date/time after this date. This is called backdating the subscription creation and is done when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:
\nsubscription[start_date] cannot be earlier than 14th February.Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The period of time by which the first term of the subscription is extended free of charge. The value is expressed in the time unit specified by free_period_unit. For example, 3 with free_period_unit = month adds 3 free months to the first term of the subscription.
Prerequisite
\nCan be used only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.The time unit for free_period.
Prerequisite
\nCan be used only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.\nConstraint
\nMust be equal to or lower than theperiod_unit of the plan item price of the subscription.Charge based on year(s)
\n* day -Charge based on day(s)
\n* month -Charge based on month(s)
\n* week -Charge based on week(s)
", "enum" : [ "day", "week", "month", "year" ], "example" : null } }, "example" : null }, "shipping_address" : { "type" : "object", "deprecated" : false, "description" : "Parameters for shipping_address\n", "properties" : { "first_name" : { "type" : "string", "deprecated" : false, "description" : "The first name of the contact.\n", "maxLength" : 150, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "The last name of the contact.\n", "maxLength" : 150, "example" : null }, "email" : { "type" : "string", "format" : "email", "deprecated" : false, "description" : "The email address.\n", "maxLength" : 70, "example" : null }, "company" : { "type" : "string", "deprecated" : false, "description" : "The company name.\n", "maxLength" : 250, "example" : null }, "phone" : { "type" : "string", "deprecated" : false, "description" : "The phone number.\n", "maxLength" : 50, "example" : null }, "line1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1\n", "maxLength" : 150, "example" : null }, "line2" : { "type" : "string", "deprecated" : false, "description" : "Address line 2\n", "maxLength" : 150, "example" : null }, "line3" : { "type" : "string", "deprecated" : false, "description" : "Address line 3\n", "maxLength" : 150, "example" : null }, "city" : { "type" : "string", "deprecated" : false, "description" : "The name of the city.\n", "maxLength" : 50, "example" : null }, "state_code" : { "type" : "string", "deprecated" : false, "description" : "The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The first name of the billing contact.
\nNote\nThe parameter billing_address and all its sub-parameters apply only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency. If changes_scheduled_at\nis in the past and a unit_price\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "example" : null }, "start_date" : { "type" : "array", "description" : "Specifies the start date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The index or identifier of the ramp to which the item price belongs. Use this index to map item_tier values to the correct ramp, as the target item_price of an item_tier may be part of multiple ramps.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The amount on the quote to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Specifies the start date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The index or identifier of the ramp to which this tier information belongs. This must be a value from the subscription_items[ramp_tier_id][i]. Since an item price can be part of multiple subscriptions ramps, this group ID specifies the ramp to which this tier information belongs.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the start date for the coupon. The period of the coupon, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the coupon. The period of the coupon, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "Resource object representing quoted_ramp
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/update_subscription_quote_for_items" : { "post" : { "summary" : "Create a quote for subscription update", "description" : "Creates a quote for updating a subscription.
If the quote is for a scheduled change, then the following resources are created:
quote and a quoted_subscription are created.quote, a quoted_ramp, and a quoted_subscription are created.For more details, see Ramps API compatibility mode.
If true\nthen the existing subscription_items\nlist for the subscription is replaced by the one provided. If false\nthen the provided subscription_items\nlist gets added to the existing list.
The number of subscription billing cycles to invoice in advance.\nIf a new term is started for the subscription due to this API call, then terms_to_charge\nis inclusive of this new term. See description for the force_term_reset\nparameter to learn more about when a subscription term is reset.
If the subscription status\nis cancelled\nand it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.\nNote:\nIt is recommended not to pass this parameter along with changed_scheduled_at.\nreactivate_from\ncan be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
changes_scheduled_at cannot be earlier than 14th February.\n.The list of IDs of the coupons to be applied. Coupon codes are also supported.
\nNote
Not applicable when Chargebee CPQ is enabled. Use coupons[] array instead.
When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
\n* end_of_term -The change is carried out at the end of the current billing cycle of the subscription.
\n* specific_date -The change is carried out as of the date specified under changes_scheduled_at\n.
The change is carried out immediately.
", "enum" : [ "immediately", "specific_date" ], "example" : null }, "changes_scheduled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "When change_option is set to specific_date, then set the date-time at which the subscription change is to happen or has happened.
Constraints
reactivate_from.changes_scheduled_at parameter does not apply to auto_collection, shipping_address, and po_number; these parameters take effect immediately when scheduling a subscription update.Backdated changes\nchanges_scheduled_atcan be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
status is active, cancelled, or non_renewing.current_term_start.The number of days from invoice.date until payment for the invoice is due.
Note: This parameter applies only when Chargebee CPQ is enabled. To request access, please contact support
", "example" : null }, "subscription" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "Parameters for subscription\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n", "maxLength" : 50, "example" : null }, "start_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.
The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status\nis future\n, in_trial\n, or cancelled.\nAlso, the value must not be earlier than changes_scheduled_at\nor start_date.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end\nis backdated, the subscription immediately goes into active\nor non_renewing\nstatus.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The first name of the billing contact.
\nNote
The parameter billing_address and all its sub-parameters apply only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency. If changes_scheduled_at\nis in the past and a unit_price\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When price overriding\nis enabled for the site, the price or per-unit price of the item can be set here. The value set for the item price\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing\nis enabled. If changes_scheduled_at\nis in the past and a unit_price_in_decimal\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "example" : null }, "start_date" : { "type" : "array", "description" : "Specifies the start date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The index or identifier of the ramp to which the item price belongs. Use this index to map item_tier values to the correct ramp, as the target item_price of an item_tier may be part of multiple ramps.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The amount on the quote to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "example" : null }, "percentage" : { "type" : "array", "description" : "The percentage of the original amount that should be deducted from it.\n", "items" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0.01, "example" : null }, "example" : null }, "amount" : { "type" : "array", "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "items" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
The operation to be carried out for the discount.
\n\n* add -The discount is attached to the subscription.
\n* remove -The discount (given by discounts[id]\n) is removed from the subscription. Subsequent invoices will no longer have the discount applied. Tip:\nIf you want to replace a discount, remove\nit and add\nanother in the same API call.
The id\nof the discount to be removed. This parameter is only relevant when discounts[operation_type]\nis remove.
Specifies the start date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The index or identifier of the ramp to which this tier information belongs. This must be a value from the subscription_items[ramp_tier_id][i]. Since an item price can be part of multiple subscriptions ramps, this group ID specifies the ramp to which this tier information belongs.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the start date for the coupon. The period of the coupon, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Specifies the end date for the coupon. The period of the coupon, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Note
The parameter applies only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.
Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "Resource object representing quoted_ramp
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/quote_line_groups" : { "get" : { "summary" : "List quote line groups", "description" : "This API retrieves all the quote line groups and lineitems for a quote.\n", "operationId" : "list_quote_line_groups", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "quote-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/quote-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The price or per-unit-price of the item price. By default, it is the value set\nfor the item_price.\nThis is only applicable when the pricing_model\nof the item_price\nis flat_fee\nor per_unit.\nThe value depends on the type of currency\n.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The amount on the quote to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Resource object representing quote
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/pdf" : { "post" : { "summary" : "Retrieve a quote as PDF", "description" : "Retrieves the quote as a PDF. The returned URL is secure, allows download and expires in 60 minutes.\n", "operationId" : "retrieve_quote_as_pdf", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "quote-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/quote-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "consolidated_view" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "When true, the quote PDF has summary of all charges on the quote. When false, the quote PDF has a detailed view of charges grouped by charge event. This parameter does not affect one-time quotes.\n", "example" : null }, "disposition_type" : { "type" : "string", "default" : "attachment", "deprecated" : false, "description" : "Determines the pdf should be rendered as inline or attachment in the browser.\n\\* attachment -\n\nPDF is rendered as attachment in the browser\n\\* inline -\n\nPDF is rendered as inline in the browser\n", "enum" : [ "attachment", "inline" ], "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "download" : { "$ref" : "#/components/schemas/Download", "description" : "Resource object representing download
" } }, "required" : [ "download" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/create_for_charge_items_and_charges" : { "post" : { "summary" : "Create a quote for charges and charge items", "description" : "Creates a quote using charge-items and one-time charges.\n", "operationId" : "create_a_quote_for_charge_and_charge_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "string", "deprecated" : false, "description" : "The quote name will be used as the pdf name of the quote.\n", "maxLength" : 100, "example" : null }, "customer_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer for which the quote needs to be created.\n", "maxLength" : 50, "example" : null }, "po_number" : { "type" : "string", "deprecated" : false, "description" : "Purchase Order Number for this quote.\n", "maxLength" : 100, "example" : null }, "notes" : { "type" : "string", "deprecated" : false, "description" : "Notes specific to this quote that you want customers to see on the quote PDF.\n", "maxLength" : 10000, "example" : null }, "expires_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Quotes will be valid till this date. After this quote will be marked as closed.\n", "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "The currency code (ISO 4217 format) of the quote.\n", "maxLength" : 3, "example" : null }, "coupon" : { "type" : "string", "deprecated" : false, "description" : "The 'One Time' coupon to be applied.\n", "maxLength" : 100, "example" : null }, "coupon_ids" : { "type" : "array", "deprecated" : false, "description" : "List of Coupons to be added.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "net_term_days" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of days from invoice.date until payment for the invoice is due.
Prerequisite\nYou can use this parameter only when Chargebee CPQ is enabled. Contact Chargebee Support to request access.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The price or per-unit-price of the item price. By default, it is the value set\nfor the item_price.\nThis is only applicable when the pricing_model\nof the item_price\nis flat_fee\nor per_unit.\nThe value depends on the type of currency\n.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The amount on the quote to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Resource object representing quote
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupons" : { "get" : { "summary" : "List coupons", "description" : "List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.\n", "operationId" : "list_coupons", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, string filter
\nUsed to uniquely identify the coupon in your website/application and to integrate with Chargebee.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
.\nSupported operators :\nis, is_not, starts_with, in, not_in
\nExample →\nid[is] = "OFF2008"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "OFF2008", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "name", "in" : "query", "description" : "optional, string filter
\nThe display name used in web interface for identifying the coupon.
\nNote:
When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.
.\nSupported operators :\nis, is_not, starts_with, in, not_in
\nExample →\nname[is_not] = "Offer 10"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "Offer 10", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "discount_type", "in" : "query", "description" : "optional, enumerated string filter\n\nThe type of deduction. Possible values are : fixed_amount, percentage.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*discount_type\\[is\\] = \"fixed_amount\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "fixed_amount", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`fixed_amount\\` - The specified amount will be deducted. \\* \\`percentage\\` - The specified percentage will be deducted. \\* \\`offer_quantity\\` - The specified units will be offered without any deduction.\n", "enum" : [ "fixed_amount", "percentage", "offer_quantity" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`fixed_amount\\` - The specified amount will be deducted. \\* \\`percentage\\` - The specified percentage will be deducted. \\* \\`offer_quantity\\` - The specified units will be offered without any deduction.\n", "enum" : [ "fixed_amount", "percentage", "offer_quantity" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`fixed_amount\\` - The specified amount will be deducted. \\* \\`percentage\\` - The specified percentage will be deducted. \\* \\`offer_quantity\\` - The specified units will be offered without any deduction.\n", "enum" : [ "fixed_amount", "percentage", "offer_quantity" ], "pattern" : "^\\[(fixed_amount|percentage|offer_quantity)(,(fixed_amount|percentage|offer_quantity))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`fixed_amount\\` - The specified amount will be deducted. \\* \\`percentage\\` - The specified percentage will be deducted. \\* \\`offer_quantity\\` - The specified units will be offered without any deduction.\n", "enum" : [ "fixed_amount", "percentage", "offer_quantity" ], "pattern" : "^\\[(fixed_amount|percentage|offer_quantity)(,(fixed_amount|percentage|offer_quantity))*\\]$", "example" : null } } } }, { "name" : "duration_type", "in" : "query", "description" : "optional, enumerated string filter\n\nSpecifies the time duration for which this coupon is attached to the subscription. Possible values are : one_time, forever, limited_period.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*duration_type\\[is\\] = \"forever\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "forever", "properties" : { "is" : { "type" : "string", "description" : "* `one_time` - The coupon stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified byperiod and period_unit. ",
"enum" : [ "one_time", "forever", "limited_period" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `one_time` - The coupon stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit. ",
"enum" : [ "one_time", "forever", "limited_period" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `one_time` - The coupon stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit. ",
"enum" : [ "one_time", "forever", "limited_period" ],
"pattern" : "^\\[(one_time|forever|limited_period)(,(one_time|forever|limited_period))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `one_time` - The coupon stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit. ",
"enum" : [ "one_time", "forever", "limited_period" ],
"pattern" : "^\\[(one_time|forever|limited_period)(,(one_time|forever|limited_period))*\\]$",
"example" : null
}
}
}
}, {
"name" : "status",
"in" : "query",
"description" : "optional, enumerated string filter\n\nStatus of the coupon. Possible values are : active, expired, archived, deleted.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is_not\\] = \"active\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "active",
"properties" : {
"is" : {
"type" : "string",
"description" : "* `active` - Can be applied to a subscription.\n* `expired` - Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions or valid_till date is past. Existing associations remain unaffected.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n* `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.",
"enum" : [ "active", "expired", "archived", "deleted", "future" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `active` - Can be applied to a subscription.\n* `expired` - Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions or valid_till date is past. Existing associations remain unaffected.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n* `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.",
"enum" : [ "active", "expired", "archived", "deleted", "future" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `active` - Can be applied to a subscription.\n* `expired` - Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions or valid_till date is past. Existing associations remain unaffected.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n* `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.",
"enum" : [ "active", "expired", "archived", "deleted", "future" ],
"pattern" : "^\\[(active|expired|archived|deleted|future)(,(active|expired|archived|deleted|future))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `active` - Can be applied to a subscription.\n* `expired` - Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions or valid_till date is past. Existing associations remain unaffected.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n* `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.",
"enum" : [ "active", "expired", "archived", "deleted", "future" ],
"pattern" : "^\\[(active|expired|archived|deleted|future)(,(active|expired|archived|deleted|future))*\\]$",
"example" : null
}
}
}
}, {
"name" : "apply_on",
"in" : "query",
"description" : "optional, enumerated string filter\n\nThe amount on the invoice to which the coupon is applied. Possible values are : invoice_amount, each_specified_item.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*apply_on\\[is\\] = \"invoice_amount\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "invoice_amount",
"properties" : {
"is" : {
"type" : "string",
"description" : "* `invoice_amount` - The coupon is applied to the invoice sub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nThe display name used in web interface for identifying the coupon.
\nNote:
When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.
.
", "maxLength" : 50, "example" : null }, "invoice_name" : { "type" : "string", "deprecated" : false, "description" : "Display name used in invoice. If it is not configured then name is used in invoice.\n", "maxLength" : 100, "example" : null }, "discount_type" : { "type" : "string", "default" : "percentage", "deprecated" : false, "description" : "Specifies the type of discount to be applied.
\n* percentage -A percentage of the original price is deducted as a discount. The discount percentage is specified in discount_percentage.
Learn more\nabout percentage\ncoupons.
A fixed amount is deducted as a discount. The discount amount is specified in discount_amount.
Learn more\nabout fixed_amount\ncoupons.
A specified number of units of the item price are offered for free. The number of free units is specified in discount_quantity.\nThe offer_quantity\noption is valid only when apply_on\nis set to each_specified_item\nand the pricing_model\nof the item price is per_unit.
Learn more\nabout offer_quantity\ncoupons.
Specifies the number of free units provided for the item price\n, without affecting the total quantity sold. This parameter is applicable only when the discount_type\nis set to offer_quantity\n.
The amount on the invoice to which the coupon is applied.
\n* invoice_amount -The coupon is applied to the invoice sub_total\n.
Discount will be applied to each unit of plan and addon items specified.
\n* each_specified_item -Applies the coupon to specified items (plans, addons, or charges), with the discount applied to each matching invoice.line_item.amount.
Requires applicability to be configured using item_constraints—for example all, criteria, or specific with item_price_ids.
When you attach this coupon to a subscription, at least one of that subscription's plans, addons, or charges must match those rules. If none do, the request fails.
\n* specified_items_total -Discount will be applied to the total of plan and addon items specified.
", "enum" : [ "invoice_amount", "each_specified_item" ], "example" : null }, "duration_type" : { "type" : "string", "default" : "forever", "deprecated" : false, "description" : "Specifies the time duration for which this coupon is attached to the subscription.
\n* forever -The coupon is attached to the subscription and applied on the invoices until explicitly removed.
\n* one_time -The coupon stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
(Deprecated)\nThe duration of time in months for which the coupon is attached to the subscription. Applicable only when duration_type\nis limited_period.
Note:\nThis parameter has been deprecated. Use period\nand period_unit\ninstead.
The coupon is included in MRR calculations for your site. This attribute is only applicable for coupons of duration_type = one_time\nand when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude one-time coupons from MRR calculations, this value is always returned false\n.
The duration of time for which the coupon is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period\n.
The unit of time for period. Applicable only when duration_type\nis limited_period\n.
A period of 1 calendar month.
\n* week -A period of 7 days.
\n* year -A period of 1 calendar year.
\n* day -A period of 24 hours.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "item_constraints" : { "type" : "object", "deprecated" : false, "description" : "Parameters for item_constraints\n", "properties" : { "constraint" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "Constraint applicable for the item\n\\* specific -\n\nCoupon applicable to specific items.\n\\* all -\n\nCoupon applicable to all items.\n\\* criteria -\n\nCoupon applicable based on criteria.\n\\* none -\n\nCoupon not applicable to any items.\n", "enum" : [ "none", "all", "specific", "criteria" ], "example" : null }, "example" : null }, "item_type" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "Item type for which this criteria is applicable for.\n\\* charge -\n\nCharge\n\\* plan -\n\nPlan\n\\* addon -\n\nAddon\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "example" : null }, "item_price_ids" : { "type" : "array", "description" : "List of item price ids for which this coupon is applicable.
\nNote:
When specifying a value for item_price_ids, make sure that the value is wrapped in square brackets ([]), for example: [cbdemo_advanced-USD-Daily] instead of cbdemo_advanced-USD-Daily; otherwise, a param_wrong_value error returns.
For information about item_price_ids, refer to Defining Price Points in Plans, Addons, and Charges.
Pass the item price period units for this criterion. period\nfollowed by period_units.\nSuch as [1 day,1 week,3 month,6 month]
Parameters for coupon_constraints.\nMultiple coupon_constraints\ncan be passed by specifying unique indices.
The resource type for the constraint. This, along with type\nand value\n, helps define the specific rule applied.
The constraint is based on customer\nrecords.
The type of coupon constraint.
\n* unique_by -Indicates - when entity_type\nis customer
customer\nattribute. The customer\nattribute is specified using value.\nFor example, if value\nis email\n, then the coupon can be redeemed only once for every unique value of customer.email.\nIn other words, when there are multiple customer\nrecords with the same value for email\n, once the coupon has been redeemed for one of those customer records, no further redemptions of the coupon are allowed for any of those customer\nrecords.The coupon is applicable only for new customer(s). A customer will be considered as new_customer\nwhen they do not have any prior non-void, non-zero-dollar invoices.
The coupon is applicable only for existing customer(s). A customer will be considered as existing_customer\nwhen they have at least one non-void, non-zero-dollar invoice.
The coupon can be redeemed up to a set number of times for a specific resource type. The maximum redemptions are specified using value\n, and the resource type is specified using entity_type.\nFor example, if entity_type\nis customer\nand value\nis 10\nthen the coupon can only be redeemed up to 10 times for any particular customer\nrecord.
The value of the coupon constraint. The possible values depend on the value of constraints[type]:
When type is unique_by, then value can be email or id.
When type is max_redemptions, then value can be any integer in the range 1 coupon.max_redemptions, inclusive.
When type is new_customer or existing_customer then value can be based_on_invoice.
Resource object representing coupon
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupons/{coupon-id}/unarchive" : { "post" : { "summary" : "Unarchive a coupon", "description" : "This API unarchives a specific coupon using the coupon ID.\n", "operationId" : "unarchive_a_coupon", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "coupon-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/coupon-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "coupon" : { "$ref" : "#/components/schemas/Coupon", "description" : "Resource object representing coupon
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupons/{coupon-id}/delete" : { "post" : { "summary" : "Delete a coupon", "description" : "If no Subscriptions/Invoices are linked to this Coupon, the Coupon will be deleted from your Chargebee site. This action cannot be undone.\n\nTo ensure that existing Subscriptions/Invoices are not affected, Coupons associated with them will not be deleted, but moved to \"Archived\" state. Once a Coupon has been archived, it cannot be edited or used again unless [unarchived](/docs/api/coupons/unarchive-a-coupon). Unused Coupons codes are deleted.\n", "operationId" : "delete_a_coupon", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "coupon-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/coupon-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "coupon" : { "$ref" : "#/components/schemas/Coupon", "description" : "Resource object representing coupon
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupons/copy" : { "post" : { "summary" : "Copy a coupon", "description" : "Copies a coupon over from one site to another. Copying of archived coupons is not supported.
The item prices that are linked to the coupon in the source site are also linked to the coupon in the destination site. However, this will only work if those item prices exist and with the same ids, in the destination site. Hence, it is recommended that the item prices be copied over before copying the coupons.
The value for redemptions is not copied. It is set to 0 for the newly created coupon. Hence, if such a coupon had expired in the source site due to redemptions having reached max_redemptions, it's status would be active in the destination site.
Resource object representing coupon
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupons/{coupon-id}" : { "get" : { "summary" : "Retrieve a coupon", "description" : "This API retrieves a specific coupon using the coupon ID.\n", "operationId" : "retrieve_a_coupon", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "coupon-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/coupon-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "coupon" : { "$ref" : "#/components/schemas/Coupon", "description" : "Resource object representing coupon
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupons/create_for_items" : { "post" : { "summary" : "Create a coupon for items", "description" : "This API creates a new coupon for a specific promotion or offers.\n", "operationId" : "create_a_coupon_for_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
.
", "maxLength" : 100, "example" : null }, "name" : { "type" : "string", "deprecated" : false, "description" : "The display name used in web interface for identifying the coupon.
\nNote:
When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.
.
", "maxLength" : 50, "example" : null }, "invoice_name" : { "type" : "string", "deprecated" : false, "description" : "Display name used in invoice. If it is not configured then name is used in invoice.\n", "maxLength" : 100, "example" : null }, "discount_type" : { "type" : "string", "default" : "percentage", "deprecated" : false, "description" : "Specifies the type of discount to be applied.
\n* percentage -A percentage of the original price is deducted as a discount. The discount percentage is specified in discount_percentage.
Learn more\nabout percentage\ncoupons.
A fixed amount is deducted as a discount. The discount amount is specified in discount_amount.
Learn more\nabout fixed_amount\ncoupons.
A specified number of units of the item price are offered for free. The number of free units is specified in discount_quantity.\nThe offer_quantity\noption is valid only when apply_on\nis set to each_specified_item\nand the pricing_model\nof the item price is per_unit.
Learn more\nabout offer_quantity\ncoupons.
Specifies the number of free units provided for the item price\n, without affecting the total quantity sold. This parameter is applicable only when the discount_type\nis set to offer_quantity\n.
The amount on the invoice to which the coupon is applied.
\n* invoice_amount -The coupon is applied to the invoice sub_total\n.
Discount will be applied to each unit of plan and addon items specified.
\n* each_specified_item -Applies the coupon to specified items (plans, addons, or charges), with the discount applied to each matching invoice.line_item.amount.
Requires applicability to be configured using item_constraints—for example all, criteria, or specific with item_price_ids.
When you attach this coupon to a subscription, at least one of that subscription's plans, addons, or charges must match those rules. If none do, the request fails.
\n* specified_items_total -Discount will be applied to the total of plan and addon items specified.
", "enum" : [ "invoice_amount", "each_specified_item" ], "example" : null }, "duration_type" : { "type" : "string", "default" : "forever", "deprecated" : false, "description" : "Specifies the time duration for which this coupon is attached to the subscription.
\n* forever -The coupon is attached to the subscription and applied on the invoices until explicitly removed.
\n* one_time -The coupon stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
(Deprecated)\nThe duration of time in months for which the coupon is attached to the subscription. Applicable only when duration_type\nis limited_period.
Note:\nThis parameter has been deprecated. Use period\nand period_unit\ninstead.
The coupon is included in MRR calculations for your site. This attribute is only applicable for coupons of duration_type = one_time\nand when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude one-time coupons from MRR calculations, this value is always returned false\n.
The duration of time for which the coupon is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period\n.
The unit of time for period. Applicable only when duration_type\nis limited_period\n.
A period of 1 calendar month.
\n* week -A period of 7 days.
\n* year -A period of 1 calendar year.
\n* day -A period of 24 hours.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "status" : { "type" : "string", "default" : "active", "deprecated" : false, "description" : "Status of the coupon.
\n* future -The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.
\n* expired -Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions\nor valid_till\ndate is past. Existing associations remain unaffected.
Cannot be applied to a subscription. Existing associations remain unaffected.
\n* active -Can be applied to a subscription.
\n* deleted -Indicates the coupon has been deleted.
", "enum" : [ "active", "archived" ], "example" : null }, "item_constraints" : { "type" : "object", "deprecated" : false, "description" : "Parameters for item_constraints\n", "properties" : { "constraint" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "Constraint applicable for the item\n\\* specific -\n\nCoupon applicable to specific items.\n\\* all -\n\nCoupon applicable to all items.\n\\* criteria -\n\nCoupon applicable based on criteria.\n\\* none -\n\nCoupon not applicable to any items.\n", "enum" : [ "none", "all", "specific", "criteria" ], "example" : null }, "example" : null }, "item_type" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "Item type for which this criteria is applicable for.\n\\* charge -\n\nCharge\n\\* plan -\n\nPlan\n\\* addon -\n\nAddon\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "example" : null }, "item_price_ids" : { "type" : "array", "description" : "List of item price ids for which this coupon is applicable.
\nNote:
When specifying a value for item_price_ids, make sure that the value is wrapped in square brackets ([]), for example: [cbdemo_advanced-USD-Daily] instead of cbdemo_advanced-USD-Daily; otherwise, a param_wrong_value error returns.
For information about item_price_ids, refer to Defining Price Points in Plans, Addons, and Charges.
Pass the item price period units for this criterion. period\nfollowed by period_units.\nSuch as [1 day,1 week,3 month,6 month]
Parameters for coupon_constraints.\nMultiple coupon_constraints\ncan be passed by specifying unique indices.
The resource type for the constraint. This, along with type\nand value\n, helps define the specific rule applied.
The constraint is based on customer\nrecords.
The type of coupon constraint.
\n* unique_by -Indicates - when entity_type\nis customer
customer\nattribute. The customer\nattribute is specified using value.\nFor example, if value\nis email\n, then the coupon can be redeemed only once for every unique value of customer.email.\nIn other words, when there are multiple customer\nrecords with the same value for email\n, once the coupon has been redeemed for one of those customer records, no further redemptions of the coupon are allowed for any of those customer\nrecords.The coupon is applicable only for new customer(s). A customer will be considered as new_customer\nwhen they do not have any prior non-void, non-zero-dollar invoices.
The coupon is applicable only for existing customer(s). A customer will be considered as existing_customer\nwhen they have at least one non-void, non-zero-dollar invoice.
The coupon can be redeemed up to a set number of times for a specific resource type. The maximum redemptions are specified using value\n, and the resource type is specified using entity_type.\nFor example, if entity_type\nis customer\nand value\nis 10\nthen the coupon can only be redeemed up to 10 times for any particular customer\nrecord.
The value of the coupon constraint. The possible values depend on the value of constraints[type]:
When type is unique_by, then value can be email or id.
When type is max_redemptions, then value can be any integer in the range 1 coupon.max_redemptions, inclusive.
When type is new_customer or existing_customer then value can be based_on_invoice.
Resource object representing coupon
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets" : { "get" : { "summary" : "List coupon sets", "description" : "Use this API to get the list of all the coupon sets.\n", "operationId" : "list_coupon_sets", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Resource object representing coupon_set
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets/{coupon-set-id}/update" : { "post" : { "summary" : "Update a coupon set", "description" : "Use this API to update a specific coupon set by updating its name and the meta_data.
Resource object representing coupon_set
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets/{coupon-set-id}" : { "get" : { "summary" : "Retrieve a coupon set", "description" : "Use this API to retrieve a specific coupon set.\n", "operationId" : "retrieve_a_coupon_set", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "coupon-set-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/coupon-set-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "coupon_set" : { "$ref" : "#/components/schemas/CouponSet", "description" : "Resource object representing coupon_set
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets/{coupon-set-id}/add_coupon_codes" : { "post" : { "summary" : "Add coupon codes to coupon set", "description" : "This API add coupon codes to an existing coupon set.\n", "operationId" : "add_coupon_codes_to_coupon_set", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "coupon-set-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/coupon-set-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "code" : { "type" : "array", "deprecated" : false, "description" : "You can pass up to 100 values per API call. You can also use the Chargebee UI to pass up to 1000 codes per operation. There is no limit on the total number of coupon codes that can be included in a coupon set.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "coupon_set" : { "$ref" : "#/components/schemas/CouponSet", "description" : "Resource object representing coupon_set
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets/{coupon-set-id}/delete_unused_coupon_codes" : { "post" : { "summary" : "Delete unused coupon codes", "description" : "Use this API to delete all the unutilised coupon codes from a specific coupon set.\n", "operationId" : "delete_unused_coupon_codes", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "coupon-set-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/coupon-set-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "coupon_set" : { "$ref" : "#/components/schemas/CouponSet", "description" : "Resource object representing coupon_set
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets/{coupon-set-id}/delete" : { "post" : { "summary" : "Delete a coupon set", "description" : "Use this endpoint to delete a specific coupon set\n", "operationId" : "delete_a_coupon_set", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "coupon-set-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/coupon-set-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "coupon_set" : { "$ref" : "#/components/schemas/CouponSet", "description" : "Resource object representing coupon_set
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_codes" : { "get" : { "summary" : "List coupon codes", "description" : "List the available coupon codes.\n", "operationId" : "list_coupon_codes", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Resource object representing coupon_code
" } }, "required" : [ "coupon_code" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_codes/{coupon-code-code}/archive" : { "post" : { "summary" : "Archive a coupon code", "description" : "Archives a coupon code thereby making it inactive. The archived coupon code cannot be applied to any subscription.\n", "operationId" : "archive_a_coupon_code", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "coupon-code-code", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/coupon-code-code", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "coupon_code" : { "$ref" : "#/components/schemas/CouponCode", "description" : "Resource object representing coupon_code
" } }, "required" : [ "coupon_code" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/addresses" : { "get" : { "summary" : "Retrieve an address", "description" : "Retrieves an address resource for a subscription and the specified label.\n", "operationId" : "retrieve_an_address", "parameters" : [ { "name" : "subscription_id", "in" : "query", "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n", "required" : true, "deprecated" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null } }, { "name" : "label", "in" : "query", "description" : "Label to identify the address. This is unique for all the address for a subscription.\n", "required" : true, "deprecated" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null } }, { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/Address", "description" : "Resource object representing address
" } }, "required" : [ "address" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update an address", "description" : "Adds or replaces the address for a subscription. If an address is already present for the specified label, it will be replaced otherwise new address is added with that label.\n", "operationId" : "update_an_address", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "subscription_id" : { "type" : "string", "deprecated" : false, "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n", "maxLength" : 50, "example" : null }, "label" : { "type" : "string", "deprecated" : false, "description" : "Label to identify the address. This is unique for all the address for a subscription.\n", "maxLength" : 50, "example" : null }, "first_name" : { "type" : "string", "deprecated" : false, "description" : "First name.\n", "maxLength" : 150, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "Last name.\n", "maxLength" : 150, "example" : null }, "email" : { "type" : "string", "format" : "email", "deprecated" : false, "description" : "Email.\n", "maxLength" : 70, "example" : null }, "company" : { "type" : "string", "deprecated" : false, "description" : "Company name.\n", "maxLength" : 250, "example" : null }, "phone" : { "type" : "string", "deprecated" : false, "description" : "Phone number.\n", "maxLength" : 50, "example" : null }, "addr" : { "type" : "string", "deprecated" : false, "description" : "Address line 1.\n", "maxLength" : 150, "example" : null }, "extended_addr" : { "type" : "string", "deprecated" : false, "description" : "Address line 2.\n", "maxLength" : 150, "example" : null }, "extended_addr2" : { "type" : "string", "deprecated" : false, "description" : "Address line 3.\n", "maxLength" : 150, "example" : null }, "city" : { "type" : "string", "deprecated" : false, "description" : "Name of the city.\n", "maxLength" : 50, "example" : null }, "state_code" : { "type" : "string", "deprecated" : false, "description" : "The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
.
", "maxLength" : 50, "example" : null }, "validation_status" : { "type" : "string", "default" : "not_validated", "deprecated" : false, "description" : "The address verification status.\n\\* partially_valid -\n\nThe address is valid for taxability but has not been validated for shipping.\n\\* not_validated -\n\nAddress is not yet validated.\n\\* invalid -\n\nAddress is invalid.\n\\* valid -\n\nAddress was validated successfully.\n", "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ], "example" : null } }, "required" : [ "label", "subscription_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/Address", "description" : "Resource object representing address
" } }, "required" : [ "address" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/usages/pdf" : { "post" : { "summary" : "Retrieve Usages for an Invoice as PDF", "description" : "Retrieves usages record for an invoice in PDF file format.\n", "operationId" : "retrieve_usages_for_an_invoice_as_pdf", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "disposition_type" : { "type" : "string", "default" : "attachment", "deprecated" : false, "description" : "Determines the pdf should be rendered as inline or attachment in the browser.\n\\* attachment -\n\nPDF is rendered as attachment in the browser\n\\* inline -\n\nPDF is rendered as inline in the browser\n", "enum" : [ "attachment", "inline" ], "example" : null }, "invoice" : { "type" : "object", "deprecated" : false, "description" : "Parameters for invoice\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "The invoice number. Acts as a identifier for invoice and typically generated sequentially.\n", "maxLength" : 50, "example" : null } }, "required" : [ "id" ], "example" : null } }, "example" : null }, "encoding" : { "invoice" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "download" : { "$ref" : "#/components/schemas/Download", "description" : "Resource object representing download
" } }, "required" : [ "download" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/usages" : { "get" : { "summary" : "Retrieve a usage", "description" : "Retrieves a usage record of a specific subscription.\n", "operationId" : "retrieve_a_usage", "parameters" : [ { "name" : "id", "in" : "query", "description" : "The unique identifier for the usage record to be retrieved.\n", "required" : true, "deprecated" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null } }, { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "usage" : { "$ref" : "#/components/schemas/Usage", "description" : "Resource object representing usage
" } }, "required" : [ "usage" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Create a usage", "description" : "Creates a usage record for an item price in a subscription. The item price must belong to a metered item.
Max Usages
The maximum number of usages that can be recorded for the entire lifetime of a subscription is 5000. Contact Support\nif you want this limit to be increased for your site.
The time at which this usage occurred. Chargebee bills only those usages whose\nusage_date\nfalls within a time when the subscription status\nwas active\nor non_renewing.\nHowever, the remaining usage records are still stored and are\nretrievable.
Note:\nIf usage_date\ncorresponds to a time already invoiced, then it is stored but never invoiced unless the invoice is regenerated\n.
Resource object representing usage
" } }, "required" : [ "usage" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/delete_usage" : { "post" : { "summary" : "Delete a usage", "description" : "Deletes a usage record. This operation cannot be invoked for a usage record that has been [invoiced](/docs/api/usages).\n", "operationId" : "delete_a_usage", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "A unique and immutable id for the usage. If not provided, it is autogenerated.\n", "maxLength" : 100, "example" : null } }, "required" : [ "id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "usage" : { "$ref" : "#/components/schemas/Usage", "description" : "Resource object representing usage
" } }, "required" : [ "usage" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/usages" : { "get" : { "summary" : "List usages", "description" : "Retrieves the list of usages.\n", "operationId" : "list_usages", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, timestamp(UTC) in seconds filter
\nThe time at which this usage occurred. Chargebee bills only those usages whose\nusage_date\nfalls within a time when the subscription status\nwas active\nor non_renewing.\nHowever, the remaining usage records are still stored and are\nretrievable.
Note:\nIf usage_date\ncorresponds to a time already invoiced, then it is stored but never invoiced unless the invoice is regenerated\n.\nSupported operators :\nafter, before, on, between
Example →\nusage_date[after] = "1601220958"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1601220958", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "updated_at", "in" : "query", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1601220958", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "item_price_id", "in" : "query", "description" : "optional, string filter\n\nThe id of the [item price](/docs/api/item_prices)\nto which this usage belongs. The item price must be a part of the subscription or should have been part of it historically.\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*item_price_id\\[is\\] = \"sprout\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "sprout", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } } } }, { "name" : "invoice_id", "in" : "query", "description" : "optional, string filter
\nWhen the usage has been invoiced, this is the id\nof the invoice.\nThis is cleared when the invoice is voided\nor deleted.\nSupported operators :\nis, is_not, starts_with, is_present
Example →\ninvoice_id[is] = "null"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null } }, { "name" : "source", "in" : "query", "description" : "optional, enumerated string filter\n\nThe source from which the usage record was created. Possible values are : admin_console, api, bulk_operation.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*source\\[is\\] = \"api\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "api", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`admin_console\\` - Operation made through the Chargebee admin UI \\* \\`api\\` - Operation made through the API \\* \\`bulk_operation\\` - Operation that are triggerd through bulk operation.\n", "enum" : [ "admin_console", "api", "bulk_operation" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`admin_console\\` - Operation made through the Chargebee admin UI \\* \\`api\\` - Operation made through the API \\* \\`bulk_operation\\` - Operation that are triggerd through bulk operation.\n", "enum" : [ "admin_console", "api", "bulk_operation" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`admin_console\\` - Operation made through the Chargebee admin UI \\* \\`api\\` - Operation made through the API \\* \\`bulk_operation\\` - Operation that are triggerd through bulk operation.\n", "enum" : [ "admin_console", "api", "bulk_operation" ], "pattern" : "^\\[(admin_console|api|bulk_operation)(,(admin_console|api|bulk_operation))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`admin_console\\` - Operation made through the Chargebee admin UI \\* \\`api\\` - Operation made through the API \\* \\`bulk_operation\\` - Operation that are triggerd through bulk operation.\n", "enum" : [ "admin_console", "api", "bulk_operation" ], "pattern" : "^\\[(admin_console|api|bulk_operation)(,(admin_console|api|bulk_operation))*\\]$", "example" : null } } } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\nusage_date\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"usage_date\"*\n\nThis will sort the result based on the 'usage_date' attribute in ascending(earliest first) order.\n", "required" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "asc" : { "type" : "string", "enum" : [ "usage_date", "updated_at" ], "example" : null }, "desc" : { "type" : "string", "enum" : [ "usage_date", "updated_at" ], "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "usage" : { "$ref" : "#/components/schemas/Usage", "description" : "Resource object representing usage" } }, "required" : [ "usage" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/events" : { "get" : { "summary" : "List events", "description" : "Retrieves list of events.\n", "operationId" : "list_events", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Resource object representing event
" } }, "required" : [ "event" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/comments/{comment-id}/delete" : { "post" : { "summary" : "Delete a comment", "description" : "Delete a comment for an [entity](/docs/api/v2/pcv-1/comments/create-a-comment#entity_type) identified by comment ID.\n\nOnly the comments that are added via Admin console and API can be deleted. Chargebee generated \"System\" comments cannot be deleted.\n", "operationId" : "delete_a_comment", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "comment-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/comment-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "comment" : { "$ref" : "#/components/schemas/Comment", "description" : "Resource object representing comment
" } }, "required" : [ "comment" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/comments/{comment-id}" : { "get" : { "summary" : "Retrieve a comment", "description" : "Retrieve a comment for an entity identified by comment ID.\n", "operationId" : "retrieve_a_comment", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "comment-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/comment-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "comment" : { "$ref" : "#/components/schemas/Comment", "description" : "Resource object representing comment
" } }, "required" : [ "comment" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/comments" : { "get" : { "summary" : "List comments", "description" : "Retrieve the list of comments sorted by the recent ones on the top.\n\nIf you want to retrieve the list of comments for an [entity](/docs/api/v2/pcv-1/comments/list-comments), for example, subscription you can filter them by passing the entity type and unique identifier for that entity, for example, subscription ID.\n", "operationId" : "list_comments", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Resource object representing comment
" } }, "required" : [ "comment" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/portal_sessions" : { "post" : { "summary" : "Create a portal session", "description" : "Creates a portal session for a customer. The session resource in the response contains the access URL. Forward the customer to that access URL. If you would like to logout the customer later via API call, you need to store the id of the portal session resource returned by this API. While creating a session, you also need to pass the redirect URL to which your customers will be sent to upon logout from the portal UI.\n", "operationId" : "create_a_portal_session", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "redirect_url" : { "type" : "string", "deprecated" : false, "description" : "URL to redirect when the user logs out from the portal.\n", "maxLength" : 250, "example" : null }, "forward_url" : { "type" : "string", "deprecated" : false, "description" : "By default access_url redirects the customer to the portal home page. If you would like to redirect the customer to a different URL, you can use this parameter to do so.\n\n**Note:**\nThis parameter is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html)\nportal.\n", "maxLength" : 250, "example" : null }, "customer" : { "type" : "object", "deprecated" : false, "description" : "Parameters for customer\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Identifier of the customer.\n", "maxLength" : 50, "example" : null } }, "required" : [ "id" ], "example" : null } }, "example" : null }, "encoding" : { "customer" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "portal_session" : { "$ref" : "#/components/schemas/PortalSession", "description" : "Resource object representing portal_session
" } }, "required" : [ "portal_session" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/portal_sessions/{portal-session-id}/activate" : { "post" : { "summary" : "Activate a portal session", "description" : "When an user is sent back to your return URL with session details, you should validate that information by calling this API. The details passed to the **return_url** should be sent as below:\n\n* **auth_session_id** - this should be sent as part of the endpoint.\n* **auth_session_token** - this should be sent as value for the input parameter **token**.\n\n**Note:** This API is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html) portal.\n", "operationId" : "activate_a_portal_session", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "portal-session-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/portal-session-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "token" : { "type" : "string", "deprecated" : false, "description" : "Unique pre-authenticated portal session token to access customer portal directly.\n", "maxLength" : 70, "example" : null } }, "required" : [ "token" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "portal_session" : { "$ref" : "#/components/schemas/PortalSession", "description" : "Resource object representing portal_session
" } }, "required" : [ "portal_session" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/portal_sessions/{portal-session-id}/logout" : { "post" : { "summary" : "Logout a portal session", "description" : "Logs out the portal session. Typically this should be called when customers logout of your application.\n\nIf this API is called for a Portal Session that currently is in :\n\n* \"created\" status, the session status will be marked as \"logged_out\" and the access URL will become invalid.\n* \"logged_in\" status, the session status will be marked as \"logged_out\" and customer will not be able to use that session.\n* \"logged_out\" status, this will return normally without changing any attribute of this resource.\n", "operationId" : "logout_a_portal_session", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "portal-session-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/portal-session-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "portal_session" : { "$ref" : "#/components/schemas/PortalSession", "description" : "Resource object representing portal_session
" } }, "required" : [ "portal_session" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/portal_sessions/{portal-session-id}" : { "get" : { "summary" : "Retrieve a portal session", "description" : "This API retrieves a portal session using portal_session_id\nas a path parameter.
Resource object representing portal_session
" } }, "required" : [ "portal_session" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/site_migration_details" : { "get" : { "summary" : "List site migration details", "description" : "This endpoint lists the site migration details.\n", "operationId" : "list_site_migration_details", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Resource object representing resource_migration
" } }, "required" : [ "resource_migration" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/time_machines/{time-machine-name}" : { "get" : { "summary" : "Retrieve a time machine", "description" : "Retrieves the time machine. Currently only one time machine is available per site and is named 'delorean'.\n", "operationId" : "retrieve_a_time_machine", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "time-machine-name", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/time-machine-name", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "time_machine" : { "$ref" : "#/components/schemas/TimeMachine", "description" : "Resource object representing time_machine
" } }, "required" : [ "time_machine" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/time_machines/{time-machine-name}/travel_forward" : { "post" : { "summary" : "Travel forward", "description" : "Travel forward in time. This operation is **asynchronous**\n.\nYou need to check if the \"start afresh\" operation has completed by checking if the time travel status is **successful**\nby retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests.\nUse method **waitForTimeTravelCompletion()** on the returned time_machine resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion()** on the returned time_machine resource which will block until the time travel completes.\n", "operationId" : "travel_forward", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "time-machine-name", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/time-machine-name", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "destination_time" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The **time**\nto travel to. Should be between the 'current' destination time of the time machine and present time.\n", "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "time_machine" : { "$ref" : "#/components/schemas/TimeMachine", "description" : "Resource object representing time_machine
" } }, "required" : [ "time_machine" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/time_machines/{time-machine-name}/start_afresh" : { "post" : { "summary" : "Start Afresh", "description" : "Restart the time machine. This will clear the \"customer\" data like customer details, subscriptions, invoices, transactions. Also a time travel is initiated to travel back to specified genesis time.\n\n**Note:**\nThis API call is asynchronous.\nYou need to check if the \"start afresh\" operation has completed by checking if the time travel status is **successful**\nby retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for time travel completion**\nfunction provided as a instance method in the library.\nUse method **waitForTimeTravelCompletion()** on the returned **time_machine** resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion()** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **WaitForTimeTravelCompletion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes. Use method **waitForTimeTravelCompletion** on the returned **time_machine** resource which will block until the time travel completes. Use method **wait_for_time_travel_completion** on the returned **time_machine** resource which will block until the time travel completes.\n", "operationId" : "start_afresh", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "time-machine-name", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/time-machine-name", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "genesis_time" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The genesis time to travel back as part of the reset operation. If not provided, then the travel is set to 6 months in the past.\n\n**Note:**\nCan only be in the past.\n", "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "time_machine" : { "$ref" : "#/components/schemas/TimeMachine", "description" : "Resource object representing time_machine
" } }, "required" : [ "time_machine" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/customers" : { "post" : { "summary" : "Export Customers", "description" : "This API triggers export of customer data. The exported zip file contains CSV files with customer-related data.\n", "operationId" : "export_customers", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "export_type" : { "type" : "string", "default" : "data", "deprecated" : false, "description" : "Determines the format of the data. Returns the export type based on the selected value.\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", "enum" : [ "data", "import_friendly_data" ], "example" : null }, "business_entity_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The unique ID of the \\[business entity\\](/docs/api/getting-started) of this subscription. This is always the same as the \\[business entity\\](/docs/api/subscriptions/subscription-object#customer_id) of the customer. \\*\\*Supported operators :\\*\\* is, is_not, starts_with \\*\\*Example →\\*\\* \\*business_entity_id\\\\\\[is\\\\\\] = \"business_entity_id\"\\*\n", "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } } }, "customer" : { "type" : "object", "deprecated" : false, "description" : "Parameters for customer\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "Identifier of the customer.\n", "example" : "9bsvnHgsvmsI", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "first_name" : { "type" : "object", "deprecated" : false, "description" : "First name of the customer\n", "example" : "John", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } }, "last_name" : { "type" : "object", "deprecated" : false, "description" : "Last name of the customer\n", "example" : "Clint", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } }, "email" : { "type" : "object", "deprecated" : false, "description" : "Email of the customer. Configured email notifications will be sent to this email.\n", "example" : "john@test.com", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } }, "company" : { "type" : "object", "deprecated" : false, "description" : "Company name of the customer.\n", "example" : "Globex Corp", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } }, "phone" : { "type" : "object", "deprecated" : false, "description" : "Phone number of the customer\n", "example" : "(541) 754-3010", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } }, "auto_collection" : { "type" : "object", "deprecated" : false, "description" : "Whether payments needs to be collected automatically for this customer\n", "example" : "on", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`on\\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \\* \\`off\\` - Automatic collection of charges will not be made. All payments must be recorded offline.\n", "enum" : [ "on", "off" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`on\\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \\* \\`off\\` - Automatic collection of charges will not be made. All payments must be recorded offline.\n", "enum" : [ "on", "off" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`on\\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \\* \\`off\\` - Automatic collection of charges will not be made. All payments must be recorded offline.\n", "enum" : [ "on", "off" ], "pattern" : "^\\[(on|off)(,(on|off))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`on\\` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \\* \\`off\\` - Automatic collection of charges will not be made. All payments must be recorded offline.\n", "enum" : [ "on", "off" ], "pattern" : "^\\[(on|off)(,(on|off))*\\]$", "example" : null } } }, "taxability" : { "type" : "object", "deprecated" : false, "description" : "Specifies if the customer is liable for tax\n", "example" : "taxable", "properties" : { "is" : { "type" : "string", "description" : "* `taxable` - Computes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.\n* `exempt` -entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.To filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/attached_items" : { "post" : { "summary" : "Export Attached Items", "description" : "This API triggers export of attached item data. The exported zip file contains CSV files with attached item-related data.\n", "operationId" : "export_attached_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "item_type" : { "type" : "object", "deprecated" : false, "description" : "optional, enumerated string filter
\nTo filter based on the type of of the attached item. Possible values are : addon\n, charge.\nPossible values are : plan, addon, charge.
Supported operators :\nis, is_not, in, not_in
\nExample →\nitem_type[is_not] = "plan"
", "example" : "plan", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "pattern" : "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "pattern" : "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$", "example" : null } } }, "attached_item" : { "type" : "object", "deprecated" : false, "description" : "Parameters for attached_item\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "Filter attached items based on their id.\n", "example" : "bec0c324-adb6-44d3-ad4f-694f449be97c", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "item_id" : { "type" : "object", "deprecated" : false, "description" : "Filter attached items based on the item_id\nof the item being attached.
Filter attached items based on the type\nof attached item. Possible values are : recommended\n, mandatory\n, optional\n.
quantity and billing_cycles for the addon, for when it is applied to subscriptions with the plan.",
"enum" : [ "recommended", "mandatory", "optional" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `recommended` - The addon is recommended to go with the plan-item when using Checkout or Portal.\n* `mandatory` - The addon is attached automatically to the subscription for the plan-item unless explicitly removed via API.\n* `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a quantity and billing_cycles for the addon, for when it is applied to subscriptions with the plan.",
"enum" : [ "recommended", "mandatory", "optional" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `recommended` - The addon is recommended to go with the plan-item when using Checkout or Portal.\n* `mandatory` - The addon is attached automatically to the subscription for the plan-item unless explicitly removed via API.\n* `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a quantity and billing_cycles for the addon, for when it is applied to subscriptions with the plan.",
"enum" : [ "recommended", "mandatory", "optional" ],
"pattern" : "^\\[(recommended|mandatory|optional)(,(recommended|mandatory|optional))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `recommended` - The addon is recommended to go with the plan-item when using Checkout or Portal.\n* `mandatory` - The addon is attached automatically to the subscription for the plan-item unless explicitly removed via API.\n* `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a quantity and billing_cycles for the addon, for when it is applied to subscriptions with the plan.",
"enum" : [ "recommended", "mandatory", "optional" ],
"pattern" : "^\\[(recommended|mandatory|optional)(,(recommended|mandatory|optional))*\\]$",
"example" : null
}
}
},
"charge_on_event" : {
"type" : "object",
"deprecated" : false,
"description" : "Indicates when the item is charged. This attribute only applies to charge-items.\n",
"example" : "subscription_creation",
"properties" : {
"is" : {
"type" : "string",
"description" : "* `subscription_creation` - the time of creation of the subscription.\n* `subscription_trial_start` - the time when the trial period of the subscription begins.\n* `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.\n* `subscription_activation` - the moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.\n* `contract_termination` - when a contract term is terminated.\n* `on_demand` - Item can be charged on demand",
"enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination", "on_demand" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `subscription_creation` - the time of creation of the subscription.\n* `subscription_trial_start` - the time when the trial period of the subscription begins.\n* `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.\n* `subscription_activation` - the moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.\n* `contract_termination` - when a contract term is terminated.\n* `on_demand` - Item can be charged on demand",
"enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination", "on_demand" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `subscription_creation` - the time of creation of the subscription.\n* `subscription_trial_start` - the time when the trial period of the subscription begins.\n* `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.\n* `subscription_activation` - the moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.\n* `contract_termination` - when a contract term is terminated.\n* `on_demand` - Item can be charged on demand",
"enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination", "on_demand" ],
"pattern" : "^\\[(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand)(,(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `subscription_creation` - the time of creation of the subscription.\n* `subscription_trial_start` - the time when the trial period of the subscription begins.\n* `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.\n* `subscription_activation` - the moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.\n* `contract_termination` - when a contract term is terminated.\n* `on_demand` - Item can be charged on demand",
"enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination", "on_demand" ],
"pattern" : "^\\[(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand)(,(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand))*\\]$",
"example" : null
}
}
},
"updated_at" : {
"type" : "object",
"deprecated" : false,
"description" : "Filter attached items based on when the attached items were last updated.\n",
"example" : "1243545465",
"properties" : {
"after" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"before" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"on" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"between" : {
"type" : "string",
"pattern" : "^\\[\\d{10},\\d{10}\\]$",
"example" : null
}
}
},
"parent_item_id" : {
"type" : "object",
"deprecated" : false,
"description" : "The id of the plan-item to which the item is attached.\n",
"example" : "silver",
"properties" : {
"is" : {
"type" : "string",
"minLength" : 1,
"example" : null
},
"is_not" : {
"type" : "string",
"minLength" : 1,
"example" : null
},
"starts_with" : {
"type" : "string",
"minLength" : 1,
"example" : null
},
"in" : {
"type" : "string",
"pattern" : "^\\[(.*)(,.*)*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"pattern" : "^\\[(.*)(,.*)*\\]$",
"example" : null
}
}
}
},
"example" : null
}
},
"example" : null
},
"encoding" : {
"attached_item" : {
"style" : "deepObject",
"explode" : true
}
}
}
}
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"export" : {
"$ref" : "#/components/schemas/Export",
"description" : "Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/transactions" : { "post" : { "summary" : "Export Transactions", "description" : "This API triggers export of transaction data. The exported zip file contains CSV files with transaction-related data.\n", "operationId" : "export_transactions", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "transaction" : { "type" : "object", "deprecated" : false, "description" : "Parameters for transaction\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "Uniquely identifies the transaction.\n", "example" : "txn_88ybdbsnvf2", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "customer_id" : { "type" : "object", "deprecated" : false, "description" : "Identifier of the customer for which this transaction is made\n", "example" : "5hjdk8nOpd", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "subscription_id" : { "type" : "object", "deprecated" : false, "description" : "Identifier of the subscription for which this transaction is made.\n", "example" : "5hjdk8nOpd", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "payment_source_id" : { "type" : "object", "deprecated" : false, "description" : "To filter based on Transaction payment source id.\n", "example" : "pm_3Nl8XXUQUXDVFa2", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "payment_method" : { "type" : "object", "deprecated" : false, "description" : "The payment method of this transaction\n", "example" : "card", "properties" : { "is" : { "type" : "string", "description" : "* `card` - Card\n* `cash` - Cash\n* `check` - Check\n* `chargeback` - Only applicable for a transaction oftype = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a refund.\n* `bank_transfer` - Bank Transfer\n* `amazon_payments` - Amazon Payments\n* `paypal_express_checkout` - Paypal Express Checkout\n* `direct_debit` - Direct Debit\n* `alipay` - Alipay \n* `unionpay` - Unionpay\n* `apple_pay` - Apple Pay\n* `wechat_pay` - WeChat Pay \n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `ideal` - IDEAL\n* `google_pay` - Google Pay\n* `sofort` - Sofort\n* `bancontact` - Bancontact\n* `giropay` - giropay\n* `dotpay` - Dotpay\n* `other` - Payment Methods other than the above types\n* `app_store` - **(Deprecated)** App Store\n* `upi` - upi\n* `netbanking_emandates` - netbanking_emandates\n* `play_store` - **(Deprecated)** Play Store\n* `custom` - Custom\n* `boleto` - boleto\n* `venmo` - Venmo \n* `pay_to` - PayTo \n* `faster_payments` - Faster Payments \n* `sepa_instant_transfer` - Sepa Instant Transfer \n* `automated_bank_transfer` - Automated Bank Transfer \n* `klarna_pay_now` - Klarna Pay Now \n* `online_banking_poland` - Online Banking Poland \n* `payconiq_by_bancontact` - Payconiq by Bancontact \n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Stablecoin \n* `kakao_pay` - Kakao Pay \n* `naver_pay` - Naver Pay \n* `revolut_pay` - Revolut Pay \n* `cash_app_pay` - Cash App Pay \n* `pix` - Payments made via Pix \n* `twint` - Twint \n* `go_pay` - Go Pay \n* `grab_pay` - Grab Pay \n* `pay_co` - Pay Co \n* `after_pay` - After Pay \n* `swish` - Swish \n* `payme` - PayMe \n* `klarna` - Payments made via Klarna ",
"enum" : [ "card", "cash", "check", "chargeback", "bank_transfer", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "other", "upi", "netbanking_emandates", "custom", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `card` - Card\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 ",
"enum" : [ "card", "cash", "check", "chargeback", "bank_transfer", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "other", "upi", "netbanking_emandates", "custom", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `card` - Card\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 ",
"enum" : [ "card", "cash", "check", "chargeback", "bank_transfer", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "other", "upi", "netbanking_emandates", "custom", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna" ],
"pattern" : "^\\[(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna)(,(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `card` - Card\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 ",
"enum" : [ "card", "cash", "check", "chargeback", "bank_transfer", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "other", "upi", "netbanking_emandates", "custom", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna" ],
"pattern" : "^\\[(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna)(,(card|cash|check|chargeback|bank_transfer|amazon_payments|paypal_express_checkout|direct_debit|alipay|unionpay|apple_pay|wechat_pay|ach_credit|sepa_credit|ideal|google_pay|sofort|bancontact|giropay|dotpay|other|app_store|upi|netbanking_emandates|play_store|custom|boleto|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|pix|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|klarna))*\\]$",
"example" : null
}
}
},
"gateway" : {
"type" : "object",
"deprecated" : false,
"description" : "Gateway through which this transaction was done. Applicable only for 'Card' Payment Method\n",
"example" : "stripe",
"properties" : {
"is" : {
"type" : "string",
"description" : "* `chargebee` - Chargebee test gateway.\n* `chargebee_payments` - Chargebee Payments gateway\n* `adyen` - Adyen is a payment gateway.\n* `stripe` - Stripe is a payment gateway.\n* `wepay` - WePay is a payment gateway.\n* `braintree` - Braintree is a payment gateway.\n* `authorize_net` - Authorize.net is a payment gateway\n* `paypal_pro` - PayPal Pro Account is a payment gateway.\n* `pin` - Pin is a payment gateway\n* `eway` - eWAY Account is a payment gateway.\n* `eway_rapid` - eWAY Rapid is a payment gateway.\n* `worldpay` - WorldPay is a payment gateway\n* `balanced_payments` - Balanced is a payment gateway\n* `beanstream` - Bambora(formerly known as Beanstream) is a payment gateway.\n* `bluepay` - BluePay is a payment gateway.\n* `elavon` - Elavon Virtual Merchant is a payment solution.\n* `first_data_global` - First Data Global Gateway Virtual Terminal Account\n* `hdfc` - HDFC Account is a payment gateway.\n* `migs` - MasterCard Internet Gateway Service payment gateway.\n* `nmi` - NMI is a payment gateway.\n* `ogone` - Ingenico ePayments (formerly known as Ogone) is a payment gateway.\n* `paymill` - PAYMILL is a payment gateway.\n* `paypal_payflow_pro` - PayPal Payflow Pro is a payment gateway.\n* `sage_pay` - Sage Pay is a payment gateway.\n* `tco` - 2Checkout is a payment gateway.\n* `wirecard` - WireCard Account is a payment service provider.\n* `amazon_payments` - Amazon Payments is a payment service provider.\n* `paypal_express_checkout` - PayPal Express Checkout is a payment gateway.\n* `gocardless` - GoCardless is a payment service provider.\n* `orbital` - Chase Paymentech(Orbital) is a payment gateway.\n* `moneris_us` - Moneris USA is a payment gateway.\n* `moneris` - Moneris is a payment gateway.\n* `bluesnap` - BlueSnap is a payment gateway.\n* `cybersource` - CyberSource is a payment gateway.\n* `vantiv` - Vantiv is a payment gateway.\n* `checkout_com` - Checkout.com is a payment gateway.\n* `paypal` - PayPal Commerce is a payment gateway.\n* `ingenico_direct` - Worldline Online Payments is a payment gateway.\n* `exact` - Exact Payments is a payment gateway.\n* `mollie` - Mollie is a payment gateway.\n* `quickbooks` - Intuit QuickBooks Payments gateway\n* `razorpay` - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.\n* `global_payments` - Global Payments is a payment service provider.\n* `bank_of_america` - Bank of America Gateway\n* `ecentric` - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.\n* `metrics_global` - Metrics global is a leading payment service provider providing unified payment services in the US.\n* `windcave` - Windcave provides an end to end payment processing solution in ANZ and other leading global markets.\n* `pay_com` - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.\n* `ebanx` - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.\n* `dlocal` - Dlocal provides payment solutions for global commerce by accepting local payment methods.\n* `nuvei` - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. \n* `solidgate` - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. \n* `paystack` - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. \n* `jp_morgan` - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.The reference number for this transaction. For example, the check number when payment_method\n= check\n.
amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"pattern" : "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"pattern" : "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\]$",
"example" : null
}
}
},
"date" : {
"type" : "object",
"deprecated" : false,
"description" : "Indicates when this transaction occurred.\n",
"example" : "1435054328",
"properties" : {
"after" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"before" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"on" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"between" : {
"type" : "string",
"pattern" : "^\\[\\d{10},\\d{10}\\]$",
"example" : null
}
}
},
"amount" : {
"type" : "object",
"deprecated" : false,
"description" : "Amount for this transaction.\n",
"example" : "1200",
"properties" : {
"is" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"is_not" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"lt" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"lte" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"gt" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"gte" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"between" : {
"type" : "string",
"pattern" : "^\\[-?\\d+,-?\\d+\\]$",
"example" : null
}
}
},
"amount_capturable" : {
"type" : "object",
"deprecated" : false,
"description" : "To filter based on transaction's unused authorized/blocked amount.\n",
"example" : "1200",
"properties" : {
"is" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"is_not" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"lt" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"lte" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"gt" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"gte" : {
"type" : "string",
"format" : "number",
"pattern" : "^-?\\d+$",
"example" : null
},
"between" : {
"type" : "string",
"pattern" : "^\\[-?\\d+,-?\\d+\\]$",
"example" : null
}
}
},
"status" : {
"type" : "object",
"deprecated" : false,
"description" : "The status of this transaction.\n",
"example" : "success",
"properties" : {
"is" : {
"type" : "string",
"description" : "\\* \\`in_progress\\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
"enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "\\* \\`in_progress\\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
"enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "\\* \\`in_progress\\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
"enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ],
"pattern" : "^\\[(in_progress|success|voided|failure|timeout|needs_attention|late_failure)(,(in_progress|success|voided|failure|timeout|needs_attention|late_failure))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "\\* \\`in_progress\\` - Transaction is being processed by the gateway. This typically happens for [direct debit transactions](https://www.chargebee.com/docs/direct-debit-payments.html) or, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
"enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ],
"pattern" : "^\\[(in_progress|success|voided|failure|timeout|needs_attention|late_failure)(,(in_progress|success|voided|failure|timeout|needs_attention|late_failure))*\\]$",
"example" : null
}
}
},
"updated_at" : {
"type" : "object",
"deprecated" : false,
"description" : "To filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/differential_prices" : { "post" : { "summary" : "Export Differential Price", "description" : "This API triggers export of differential price data. The exported zip file contains CSV files with differential price-related data.\n", "operationId" : "export_differential_price", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "item_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter Item Id of Addon / Charge item price for which differential pricing is applied to. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*item_id\\\\\\[is\\\\\\] = \"day-pass\"\\*\n", "example" : "day-pass", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "differential_price" : { "type" : "object", "deprecated" : false, "description" : "Parameters for differential_price\n", "properties" : { "item_price_id" : { "type" : "object", "deprecated" : false, "description" : "The id of the item price (addon\nor charge\n) whose price should change according to the plan-item it is applied to.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/item_families" : { "post" : { "summary" : "Export Item Families", "description" : "This API triggers export of item family data. The exported zip file contains CSV files with item family-related data.\n", "operationId" : "export_item_families", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "business_entity_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter
\nThe unique ID of the\nbusiness entity\nof this item_family.\nLearn more\nabout all the scenarios before using this filter.
Supported operators :\nis, is_present
\nExample →\nbusiness_entity_id[is_present] = "true"
", "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "description" : "null\n", "enum" : [ "true", "false" ], "example" : null } } }, "include_site_level_resources" : { "type" : "object", "deprecated" : false, "description" : "optional, boolean filter
\nDefault value is true . To exclude site-level resources in specific cases, set this parameter to false.\nPossible values are : true, false
Supported operators :\nis
\nExample →\ninclude_site_level_resources[is] = "null"
", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null }, "item_family" : { "type" : "object", "deprecated" : false, "description" : "Parameters for item_family\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "The identifier for the item family. It is unique and immutable.\n", "example" : "family-id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "name" : { "type" : "object", "deprecated" : false, "description" : "A unique display name for the item family. This is visible only in Chargebee and not to customers.\n", "example" : "family-name", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } } }, "updated_at" : { "type" : "object", "deprecated" : false, "description" : "When the item family was last updated.\n", "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, "example" : null } }, "example" : null }, "encoding" : { "item_family" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "export" : { "$ref" : "#/components/schemas/Export", "description" : "Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/invoices" : { "post" : { "summary" : "Export Invoices", "description" : "This API triggers export of invoice data. The exported zip file contains CSV files with invoice-related data.\n\n### Invoice Export Best Practice\n\nFor a full export, Chargebee recommends exporting data in batches by using date filters. The table below provides examples of how to set the filters: \n\n| **Scenario** | **Filter Example** | **Description** |\n|-----------------------------------------------|------------------------------------------------------------------|-----------------------------------------------|\n| Export invoices updated after January 1, 2024 | *invoice\\[updated_at\\]\\[after\\] = \"1704067200\"* | Export invoices from January 1, 2024 onwards. |\n| Export invoices for 2023 | *invoice\\[updated_at\\]\\[between\\] = \"\\[1672531200,1704067199\\]\"* | Export all invoices for the year 2023. |\n| Export invoices for 2022 | *invoice\\[updated_at\\]\\[between\\] = \"\\[1640995200,1672531199\\]\"* | Export all invoices for the year 2022. |\n\nIf the export still fails, further reduce the date range, for example: \n\n| **Scenario** | **Filter Example** | **Description** |\n|------------------------------------|------------------------------------------------------------------|----------------------------------------------------------------------|\n| Export for the second half of 2024 | *invoice\\[updated_at\\]\\[after\\] = \"1717200000\"* | Export invoices are updated after June 1, 2024. |\n| Export for the first half of 2024 | *invoice\\[updated_at\\]\\[between\\] = \"\\[1704067200,1717199999\\]\"* | Export invoices updated between January 1, 2024, and May 31, 2024. |\n| Export for the second half of 2023 | *invoice\\[updated_at\\]\\[between\\] = \"\\[1685577600,1704067199\\]\"* | Export invoices updated between June 1, 2023, and December 31, 2023. |\n| Export for the first half of 2023 | *invoice\\[updated_at\\]\\[between\\] = \"\\[1672531200,1685577599\\]\"* | Export invoices updated between January 1, 2023, and May 31, 2023. |\n\n**Note**\n\nThe date ranges in the examples above are just suggestions; you can adjust the date window to fit your specific needs. If an export fails due to large data volume, reduce the date window further and retry the export.\n", "operationId" : "export_invoices", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "payment_owner" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter Payment owner of an invoice. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*payment_owner\\\\\\[is\\\\\\] = \"payment_customer\"\\*\n", "example" : "payment_customer", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "invoice" : { "type" : "object", "deprecated" : false, "description" : "Parameters for invoice\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "The invoice number. Acts as a identifier for invoice and typically generated sequentially.\n", "example" : "INVOICE_654", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "subscription_id" : { "type" : "object", "deprecated" : false, "description" : "To filter based on subscription_id. NOTE: Not to be used if \\*consolidated invoicing\\* is enabled.\n", "example" : "3bdjnDnsdQn", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "customer_id" : { "type" : "object", "deprecated" : false, "description" : "The identifier of the customer this invoice belongs to.\n", "example" : "3bdjnDnsdQn", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "recurring" : { "type" : "object", "deprecated" : false, "description" : "Boolean indicating whether this invoice belongs to a subscription\n", "example" : "true", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } }, "status" : { "type" : "object", "deprecated" : false, "description" : "Current status of this invoice.\n", "example" : "paid", "properties" : { "is" : { "type" : "string", "description" : "* `paid` - Indicates a paid invoice.\n* `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period\n* `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.\n* `not_paid` - Indicates the payment is not made and all attempts to collect is failed.\n* `voided` - Indicates a voided invoice.\n* `pending` -status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.
The unpaid amount that is due on the invoice. This is calculated as: total
amount_paid\napplied_credits.applied_amountadjustment_credit_notes.cn_totallinked_taxes_withheld.amount.To filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response. Learn more about the best practice before performing full export.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/{export-id}" : { "get" : { "summary" : "Retrieve an export", "description" : "This API gets the status of the export job initiated by the Exports API. If the export job is completed, the downloads resource will also be obtained in the API response. The returned URL in the downloads resource is secure and can be downloaded. The URL expires after 4 hours. Please note that this is a public URL, and can be downloaded by anyone with whom it's shared.\n\n**Note:** In case the export is in Failed or In-process state, then the downloads resource will not be available.\n", "operationId" : "retrieve_an_export", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "export-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/export-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "export" : { "$ref" : "#/components/schemas/Export", "description" : "Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/price_variants" : { "post" : { "summary" : "Export Price Variants", "description" : "This API triggers export of price variant data. The exported zip file contains CSV files with price variant-related data.\n", "operationId" : "export_price_variants", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "business_entity_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter
\nThe unique ID of the\nbusiness entity\nof this price_variant.\nLearn more\nabout all the scenarios before using this filter.
Supported operators :\nis, is_present
\nExample →\nbusiness_entity_id[is_present] = "true"
", "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "description" : "null\n", "enum" : [ "true", "false" ], "example" : null } } }, "include_site_level_resources" : { "type" : "object", "deprecated" : false, "description" : "optional, boolean filter
\nDefault value is true . To exclude site-level resources in specific cases, set this parameter to false.\nPossible values are : true, false
Supported operators :\nis
\nExample →\ninclude_site_level_resources[is] = "null"
", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null }, "price_variant" : { "type" : "object", "deprecated" : false, "description" : "Parameters for price_variant\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "Filter variant based on their \\[id\\](/docs/api/exports) .\n", "example" : "basic", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "name" : { "type" : "object", "deprecated" : false, "description" : "Filter variant based on their name\ns.
Filter variant based on their status\n.
Filter product based on their updated time\n.
Filter product based on their created time\n.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/items" : { "post" : { "summary" : "Export Items", "description" : "This API triggers export of item data. The exported zip file contains CSV files with item-related data.\n", "operationId" : "export_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "business_entity_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter
\nThe unique ID of the\nbusiness entity\nof this item.\nLearn more\nabout all the scenarios before using this filter.
Supported operators :\nis, is_present
\nExample →\nbusiness_entity_id[is_present] = "true"
", "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "description" : "null\n", "enum" : [ "true", "false" ], "example" : null } } }, "include_site_level_resources" : { "type" : "object", "deprecated" : false, "description" : "optional, boolean filter
\nDefault value is true . To exclude site-level resources in specific cases, set this parameter to false.\nPossible values are : true, false
Supported operators :\nis
\nExample →\ninclude_site_level_resources[is] = "null"
", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null }, "item" : { "type" : "object", "deprecated" : false, "description" : "Parameters for item\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "Filter items based on item id.\n", "example" : "basic", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "item_family_id" : { "type" : "object", "deprecated" : false, "description" : "Filter items based on item_family_id\n.
Filter items based on item type\n.
Filter items based on item name\n.
Filter items based on item_applicability\n.
applicable_items can be applied to this plan-item.",
"enum" : [ "all", "restricted" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `all` - all addon-items and charge-items are applicable to this plan-item.\n* `restricted` - only the addon-items or charge-items provided in applicable_items can be applied to this plan-item.",
"enum" : [ "all", "restricted" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `all` - all addon-items and charge-items are applicable to this plan-item.\n* `restricted` - only the addon-items or charge-items provided in applicable_items can be applied to this plan-item.",
"enum" : [ "all", "restricted" ],
"pattern" : "^\\[(all|restricted)(,(all|restricted))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `all` - all addon-items and charge-items are applicable to this plan-item.\n* `restricted` - only the addon-items or charge-items provided in applicable_items can be applied to this plan-item.",
"enum" : [ "all", "restricted" ],
"pattern" : "^\\[(all|restricted)(,(all|restricted))*\\]$",
"example" : null
}
}
},
"status" : {
"type" : "object",
"deprecated" : false,
"description" : "Filter items based on item status\n.
id and name can be reused. Deleted items can be retrieved using List items.",
"enum" : [ "active", "archived", "deleted" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `active` - The item can be used to create new item prices.\n* `archived` - The item is no longer active and no new item prices can be created\n* `deleted` - Indicates that the item has been deleted. The id and name can be reused. Deleted items can be retrieved using List items.",
"enum" : [ "active", "archived", "deleted" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `active` - The item can be used to create new item prices.\n* `archived` - The item is no longer active and no new item prices can be created\n* `deleted` - Indicates that the item has been deleted. The id and name can be reused. Deleted items can be retrieved using List items.",
"enum" : [ "active", "archived", "deleted" ],
"pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `active` - The item can be used to create new item prices.\n* `archived` - The item is no longer active and no new item prices can be created\n* `deleted` - Indicates that the item has been deleted. The id and name can be reused. Deleted items can be retrieved using List items.",
"enum" : [ "active", "archived", "deleted" ],
"pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
"example" : null
}
}
},
"is_giftable" : {
"type" : "object",
"deprecated" : false,
"description" : "Specifies if gift subscriptions can be created for this item.\n",
"example" : "true",
"properties" : {
"is" : {
"type" : "string",
"format" : "boolean",
"enum" : [ "true", "false" ],
"example" : null
}
}
},
"updated_at" : {
"type" : "object",
"deprecated" : false,
"description" : "Filter items based on when the items were last updated.\n",
"example" : "1243545465",
"properties" : {
"after" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"before" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"on" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"between" : {
"type" : "string",
"pattern" : "^\\[\\d{10},\\d{10}\\]$",
"example" : null
}
}
},
"enabled_for_checkout" : {
"type" : "object",
"deprecated" : false,
"description" : "Allow the plan to subscribed to via Checkout. Applies only for plan-items. \\*\\*Note:\\*\\* Only the in-app layout of Checkout is supported.\n",
"properties" : {
"is" : {
"type" : "string",
"format" : "boolean",
"enum" : [ "true", "false" ],
"example" : null
}
},
"example" : null
},
"enabled_in_portal" : {
"type" : "object",
"deprecated" : false,
"description" : "Allow customers to change their subscription to this plan via the \\[Self-Serve Portal\\](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html). Applies only for plan-items. This requires the Portal configuration to \\[allow changing subscriptions\\](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription) .\n",
"properties" : {
"is" : {
"type" : "string",
"format" : "boolean",
"enum" : [ "true", "false" ],
"example" : null
}
},
"example" : null
},
"metered" : {
"type" : "object",
"deprecated" : false,
"description" : "Specifies whether the item undergoes metered billing. When true\n, the quantity is calculated from usage records.\nWhen false\n, the quantity\nis as determined while adding an item price to the subscription. Applicable only for items of type\nplan\nor addon\nand when Metered Billing\nis enabled. The value of this attribute cannot be changed.
How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is metered.\nThis value overrides the one set at the site level\n.
quantity of all usages for the current term.\n* `last_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the most recent usage_date is taken as the net quantity consumed.\n* `max_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the maximum value is taken as the net quantity consumed.",
"enum" : [ "sum_of_usages", "last_usage", "max_usage" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `sum_of_usages` - the net quantity is the sum of the quantity of all usages for the current term.\n* `last_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the most recent usage_date is taken as the net quantity consumed.\n* `max_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the maximum value is taken as the net quantity consumed.",
"enum" : [ "sum_of_usages", "last_usage", "max_usage" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `sum_of_usages` - the net quantity is the sum of the quantity of all usages for the current term.\n* `last_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the most recent usage_date is taken as the net quantity consumed.\n* `max_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the maximum value is taken as the net quantity consumed.",
"enum" : [ "sum_of_usages", "last_usage", "max_usage" ],
"pattern" : "^\\[(sum_of_usages|last_usage|max_usage)(,(sum_of_usages|last_usage|max_usage))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `sum_of_usages` - the net quantity is the sum of the quantity of all usages for the current term.\n* `last_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the most recent usage_date is taken as the net quantity consumed.\n* `max_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the maximum value is taken as the net quantity consumed.",
"enum" : [ "sum_of_usages", "last_usage", "max_usage" ],
"pattern" : "^\\[(sum_of_usages|last_usage|max_usage)(,(sum_of_usages|last_usage|max_usage))*\\]$",
"example" : null
}
}
},
"channel" : {
"type" : "object",
"deprecated" : false,
"description" : "The subscription channel this object originated from and is maintained in.\n",
"example" : "APP STORE",
"properties" : {
"is" : {
"type" : "string",
"description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n",
"enum" : [ "web", "app_store", "play_store" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n",
"enum" : [ "web", "app_store", "play_store" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n",
"enum" : [ "web", "app_store", "play_store" ],
"pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n",
"enum" : [ "web", "app_store", "play_store" ],
"pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$",
"example" : null
}
}
}
},
"example" : null
}
},
"example" : null
},
"encoding" : {
"item" : {
"style" : "deepObject",
"explode" : true
}
}
}
}
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"export" : {
"$ref" : "#/components/schemas/Export",
"description" : "Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/deferred_revenue" : { "post" : { "summary" : "Export Deferred Revenue Reports", "description" : "**Important:**\nThis report is deprecated. Therefore, the endpoint is also deprecated.\n\nThis API triggers export for the Deferred Revenue Report.\n\n**Note:**\nThis API call is asynchronous.\nYou need to check if this operation has completed by checking if the export status is **completed**\n. You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion**\nfunction provided as an instance method in the library.\nYou need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.\n", "operationId" : "export_deferred_revenue_reports", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "report_by" : { "type" : "string", "deprecated" : false, "description" : "Determines the scope of the report. Returns the report based on the value specified.\n\\* subscription -\n\nSubscription\n\\* invoice -\n\nInvoice\n\\* product -\n\nProduct (Includes Plan, Addon and Adhoc)\n\\* customer -\n\nCustomer\n", "enum" : [ "customer", "invoice", "product", "subscription" ], "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "Value must be in ISO 4217 format. Generates the report based on the value specified. If no currency_code value is specified, then consolidated report based on base currency is returned.\n", "maxLength" : 3, "example" : null }, "report_from_month" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Obtains report data from the specified month, combined with the value specified for report_from_year.Values must be between 1 and 12, where 1 is January and 12 is December.\n", "example" : null }, "report_from_year" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Obtains report data from the specified year, combined with the value specified for report_from_month.\n", "example" : null }, "report_to_month" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Obtains report data from the specified month, combined with the value specified for report_to_year.Values must be between 1 and 12, where 1 is January and 12 is December.\n", "example" : null }, "report_to_year" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Obtains report data until the specified year, combined with the value specified for report_to_month.\n", "example" : null }, "include_discounts" : { "type" : "boolean", "default" : true, "deprecated" : false, "description" : "Returns amount with discount in the report. If value specified is false, it returns amount without discount.\n", "example" : null }, "payment_owner" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter Payment owner of an invoice. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*payment_owner\\\\\\[is\\\\\\] = \"payment_customer\"\\*\n", "example" : "payment_customer", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "item_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The plan item code. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*item_id\\\\\\[is\\\\\\] = \"silver\"\\*\n", "example" : "silver", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "item_price_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The plan item price code. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*item_price_id\\\\\\[is\\\\\\] = \"silver-USD-monthly\"\\*\n", "example" : "silver-USD-monthly", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "cancel_reason_code" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in \\*\\*Settings \\\\\\> Configure Chargebee \\\\\\> Reason Codes \\\\\\> Subscriptions \\\\\\> Subscription Cancellation\\*\\* . Must be passed if set as mandatory in the app. The codes are case-sensitive. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*cancel_reason_code\\\\\\[is\\\\\\] = \"Not Paid\"\\*\n", "example" : "Not Paid", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "business_entity_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The unique ID of the \\[business entity\\](/docs/api/getting-started) of this subscription. This is always the same as the \\[business entity\\](/docs/api/subscriptions/subscription-object#customer_id) of the customer. \\*\\*Supported operators :\\*\\* is, is_not, starts_with \\*\\*Example →\\*\\* \\*business_entity_id\\\\\\[is_not\\\\\\] = \"business_entity_id\"\\*\n", "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } } }, "invoice" : { "type" : "object", "deprecated" : false, "description" : "Parameters for invoice\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "The invoice number. Acts as a identifier for invoice and typically generated sequentially.\n", "example" : "INVOICE_654", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "recurring" : { "type" : "object", "deprecated" : false, "description" : "Boolean indicating whether this invoice belongs to a subscription\n", "example" : "true", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } }, "status" : { "type" : "object", "deprecated" : false, "description" : "Current status of this invoice.\n", "example" : "paid", "properties" : { "is" : { "type" : "string", "description" : "* `paid` - Indicates a paid invoice.\n* `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period\n* `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.\n* `not_paid` - Indicates the payment is not made and all attempts to collect is failed.\n* `voided` - Indicates a voided invoice.\n* `pending` -status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.
The unpaid amount that is due on the invoice. This is calculated as: total
amount_paid\napplied_credits.applied_amountadjustment_credit_notes.cn_totallinked_taxes_withheld.amount.To filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.
Time at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.
The date/time at which the next billing for the subscription happens. This is usually right after current_term_end\nunless multiple subscription terms were invoiced in advance using the terms_to_charge\nparameter.
If true\n, there are subscription changes scheduled on next renewal.
To filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.
Set to false\nto override for this subscription, the site-level setting\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level\n.
entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.To filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/revenue_recognition" : { "post" : { "summary" : "Export Revenue Recognition Reports", "description" : "**Important:**\nThis report is deprecated. Therefore, the endpoint is also deprecated.\n\nThis API triggers export for the revenue recognition report.\n\n**Note:**\nThis API call is asynchronous.\nYou need to check if this operation has completed by checking if the export status is **completed**\n. You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion**\nfunction provided as an instance method in the library.\nYou need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.\n", "operationId" : "export_revenue_recognition_reports", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "report_by" : { "type" : "string", "deprecated" : false, "description" : "Determines the scope of the report. Returns the report based on the value specified.\n\\* subscription -\n\nSubscription\n\\* invoice -\n\nInvoice\n\\* product -\n\nProduct (Includes Plan, Addon and Adhoc)\n\\* customer -\n\nCustomer\n", "enum" : [ "customer", "invoice", "product", "subscription" ], "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "Value must be in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)\nformat. Generates the report based on the value specified. If no currency_code value is specified, then consolidated report based on base currency is returned.\n", "maxLength" : 3, "example" : null }, "report_from_month" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Obtains report data from the specified month, combined with the value specified for report_from_year. Values must be between 1 and 12, where 1 is January and 12 is December.\n", "example" : null }, "report_from_year" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Obtains report data from the specified year, combined with the value specified for report_from_month.\n", "example" : null }, "report_to_month" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Obtains report data from the specified month, combined with the value specified for report_to_year. Values must be between 1 and 12, where 1 is January and 12 is December.\n", "example" : null }, "report_to_year" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Obtains report data until the specified year, combined with the value specified for report_to_month.\n", "example" : null }, "include_discounts" : { "type" : "boolean", "default" : true, "deprecated" : false, "description" : "Returns amount with discount in the report. If value specified is false, it returns amount without discount.\n", "example" : null }, "payment_owner" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter Payment owner of an invoice. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*payment_owner\\\\\\[is\\\\\\] = \"payment_customer\"\\*\n", "example" : "payment_customer", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "item_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The plan item code. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*item_id\\\\\\[is\\\\\\] = \"silver\"\\*\n", "example" : "silver", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "item_price_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The plan item price code. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*item_price_id\\\\\\[is\\\\\\] = \"silver-USD-monthly\"\\*\n", "example" : "silver-USD-monthly", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "cancel_reason_code" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in \\*\\*Settings \\\\\\> Configure Chargebee \\\\\\> Reason Codes \\\\\\> Subscriptions \\\\\\> Subscription Cancellation\\*\\* . Must be passed if set as mandatory in the app. The codes are case-sensitive. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*cancel_reason_code\\\\\\[is\\\\\\] = \"Not Paid\"\\*\n", "example" : "Not Paid", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "business_entity_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The unique ID of the \\[business entity\\](/docs/api/getting-started) of this subscription. This is always the same as the \\[business entity\\](/docs/api/subscriptions/subscription-object#customer_id) of the customer. \\*\\*Supported operators :\\*\\* is, is_not, starts_with \\*\\*Example →\\*\\* \\*business_entity_id\\\\\\[is_not\\\\\\] = \"business_entity_id\"\\*\n", "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } } }, "invoice" : { "type" : "object", "deprecated" : false, "description" : "Parameters for invoice\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "The invoice number. Acts as a identifier for invoice and typically generated sequentially.\n", "example" : "INVOICE_654", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "recurring" : { "type" : "object", "deprecated" : false, "description" : "Boolean indicating whether this invoice belongs to a subscription\n", "example" : "true", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } }, "status" : { "type" : "object", "deprecated" : false, "description" : "Current status of this invoice.\n", "example" : "paid", "properties" : { "is" : { "type" : "string", "description" : "* `paid` - Indicates a paid invoice.\n* `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period\n* `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings.\n* `not_paid` - Indicates the payment is not made and all attempts to collect is failed.\n* `voided` - Indicates a voided invoice.\n* `pending` -status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.
The unpaid amount that is due on the invoice. This is calculated as: total
amount_paid\napplied_credits.applied_amountadjustment_credit_notes.cn_totallinked_taxes_withheld.amount.To filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.
Time at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.
The date/time at which the next billing for the subscription happens. This is usually right after current_term_end\nunless multiple subscription terms were invoiced in advance using the terms_to_charge\nparameter.
If true\n, there are subscription changes scheduled on next renewal.
To filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.
Set to false\nto override for this subscription, the site-level setting\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level\n.
entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.To filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/credit_notes" : { "post" : { "summary" : "Export Credit Notes", "description" : "This API triggers export of credit note data. The exported zip file contains CSV files with credit note-related data.\n", "operationId" : "export_credit_notes", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "credit_note" : { "type" : "object", "deprecated" : false, "description" : "Parameters for credit_note\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "Credit-note id.\n", "example" : "CN_123", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "customer_id" : { "type" : "object", "deprecated" : false, "description" : "The identifier of the customer this Credit Note belongs to.\n", "example" : "4gmiXbsjdm", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "subscription_id" : { "type" : "object", "deprecated" : false, "description" : "To filter based on subscription_id. NOTE: Not to be used if \\*consolidated invoicing\\* feature is enabled.\n", "example" : "4gmiXbsjdm", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "reference_invoice_id" : { "type" : "object", "deprecated" : false, "description" : "The identifier of the invoice against which this Credit Note is issued\n", "example" : "INVOICE_876", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "type" : { "type" : "object", "deprecated" : false, "description" : "The credit note type. \\[Learn more\\](/docs/api/credit_notes/credit-note-object) about credit note types.\n", "example" : "adjustment", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`adjustment\\` - Adjustment Credit Note \\* \\`refundable\\` - Refundable Credit Note \\* \\`store\\` - Store Credit Note\n", "enum" : [ "adjustment", "refundable", "store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`adjustment\\` - Adjustment Credit Note \\* \\`refundable\\` - Refundable Credit Note \\* \\`store\\` - Store Credit Note\n", "enum" : [ "adjustment", "refundable", "store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`adjustment\\` - Adjustment Credit Note \\* \\`refundable\\` - Refundable Credit Note \\* \\`store\\` - Store Credit Note\n", "enum" : [ "adjustment", "refundable", "store" ], "pattern" : "^\\[(adjustment|refundable|store)(,(adjustment|refundable|store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`adjustment\\` - Adjustment Credit Note \\* \\`refundable\\` - Refundable Credit Note \\* \\`store\\` - Store Credit Note\n", "enum" : [ "adjustment", "refundable", "store" ], "pattern" : "^\\[(adjustment|refundable|store)(,(adjustment|refundable|store))*\\]$", "example" : null } } }, "reason_code" : { "type" : "object", "deprecated" : false, "description" : "The reason for issuing this Credit Note. The following reason codes are supported now\\\\\\[Deprecated; use the \\[create_reason_code\\](/docs/api/credit_notes/credit_note-object#create_reason_code) parameter instead\\\\\\]\n", "example" : "waiver", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`write_off\\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \\* \\`subscription_change\\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \\* \\`subscription_cancellation\\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \\* \\`subscription_pause\\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \\* \\`chargeback\\` - Can be set when you are recording your customer Chargebacks \\* \\`product_unsatisfactory\\` - Product Unsatisfactory \\* \\`service_unsatisfactory\\` - Service Unsatisfactory \\* \\`order_change\\` - Order Change \\* \\`order_cancellation\\` - Order Cancellation \\* \\`waiver\\` - Waiver \\* \\`other\\` - Can be set when none of the above reason codes are applicable \\* \\`fraudulent\\` - FRAUDULENT\n", "enum" : [ "write_off", "subscription_change", "subscription_cancellation", "subscription_pause", "chargeback", "product_unsatisfactory", "service_unsatisfactory", "order_change", "order_cancellation", "waiver", "other", "fraudulent" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`write_off\\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \\* \\`subscription_change\\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \\* \\`subscription_cancellation\\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \\* \\`subscription_pause\\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \\* \\`chargeback\\` - Can be set when you are recording your customer Chargebacks \\* \\`product_unsatisfactory\\` - Product Unsatisfactory \\* \\`service_unsatisfactory\\` - Service Unsatisfactory \\* \\`order_change\\` - Order Change \\* \\`order_cancellation\\` - Order Cancellation \\* \\`waiver\\` - Waiver \\* \\`other\\` - Can be set when none of the above reason codes are applicable \\* \\`fraudulent\\` - FRAUDULENT\n", "enum" : [ "write_off", "subscription_change", "subscription_cancellation", "subscription_pause", "chargeback", "product_unsatisfactory", "service_unsatisfactory", "order_change", "order_cancellation", "waiver", "other", "fraudulent" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`write_off\\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \\* \\`subscription_change\\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \\* \\`subscription_cancellation\\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \\* \\`subscription_pause\\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \\* \\`chargeback\\` - Can be set when you are recording your customer Chargebacks \\* \\`product_unsatisfactory\\` - Product Unsatisfactory \\* \\`service_unsatisfactory\\` - Service Unsatisfactory \\* \\`order_change\\` - Order Change \\* \\`order_cancellation\\` - Order Cancellation \\* \\`waiver\\` - Waiver \\* \\`other\\` - Can be set when none of the above reason codes are applicable \\* \\`fraudulent\\` - FRAUDULENT\n", "enum" : [ "write_off", "subscription_change", "subscription_cancellation", "subscription_pause", "chargeback", "product_unsatisfactory", "service_unsatisfactory", "order_change", "order_cancellation", "waiver", "other", "fraudulent" ], "pattern" : "^\\[(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent)(,(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`write_off\\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \\* \\`subscription_change\\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \\* \\`subscription_cancellation\\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \\* \\`subscription_pause\\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \\* \\`chargeback\\` - Can be set when you are recording your customer Chargebacks \\* \\`product_unsatisfactory\\` - Product Unsatisfactory \\* \\`service_unsatisfactory\\` - Service Unsatisfactory \\* \\`order_change\\` - Order Change \\* \\`order_cancellation\\` - Order Cancellation \\* \\`waiver\\` - Waiver \\* \\`other\\` - Can be set when none of the above reason codes are applicable \\* \\`fraudulent\\` - FRAUDULENT\n", "enum" : [ "write_off", "subscription_change", "subscription_cancellation", "subscription_pause", "chargeback", "product_unsatisfactory", "service_unsatisfactory", "order_change", "order_cancellation", "waiver", "other", "fraudulent" ], "pattern" : "^\\[(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent)(,(write_off|subscription_change|subscription_cancellation|subscription_pause|chargeback|product_unsatisfactory|service_unsatisfactory|order_change|order_cancellation|waiver|other|fraudulent))*\\]$", "example" : null } } }, "create_reason_code" : { "type" : "object", "deprecated" : false, "description" : "Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in \\*\\*Settings \\\\\\> Configure Chargebee \\\\\\> Reason Codes \\\\\\> Credit Notes \\\\\\> Create Credit Note\\*\\*. Must be passed if set as mandatory in the app. The codes are case-sensitive\n", "example" : "Other", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "status" : { "type" : "object", "deprecated" : false, "description" : "The credit note status.\n", "example" : "adjusted", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`adjusted\\` - When the Credit Note has been adjusted against an invoice. \\* \\`refunded\\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \\* \\`refund_due\\` - When the credits are yet to be used, or have been partially used. \\* \\`voided\\` - When the Credit Note has been cancelled.\n", "enum" : [ "adjusted", "refunded", "refund_due", "voided" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`adjusted\\` - When the Credit Note has been adjusted against an invoice. \\* \\`refunded\\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \\* \\`refund_due\\` - When the credits are yet to be used, or have been partially used. \\* \\`voided\\` - When the Credit Note has been cancelled.\n", "enum" : [ "adjusted", "refunded", "refund_due", "voided" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`adjusted\\` - When the Credit Note has been adjusted against an invoice. \\* \\`refunded\\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \\* \\`refund_due\\` - When the credits are yet to be used, or have been partially used. \\* \\`voided\\` - When the Credit Note has been cancelled.\n", "enum" : [ "adjusted", "refunded", "refund_due", "voided" ], "pattern" : "^\\[(adjusted|refunded|refund_due|voided)(,(adjusted|refunded|refund_due|voided))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`adjusted\\` - When the Credit Note has been adjusted against an invoice. \\* \\`refunded\\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \\* \\`refund_due\\` - When the credits are yet to be used, or have been partially used. \\* \\`voided\\` - When the Credit Note has been cancelled.\n", "enum" : [ "adjusted", "refunded", "refund_due", "voided" ], "pattern" : "^\\[(adjusted|refunded|refund_due|voided)(,(adjusted|refunded|refund_due|voided))*\\]$", "example" : null } } }, "date" : { "type" : "object", "deprecated" : false, "description" : "The date the Credit Note is issued.\n", "example" : "1435054328", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } }, "total" : { "type" : "object", "deprecated" : false, "description" : "Credit Note amount in cents.\n", "example" : "1200", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } }, "price_type" : { "type" : "object", "deprecated" : false, "description" : "The price type of the Credit Note.\n", "example" : "tax_exclusive", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "pattern" : "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "pattern" : "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\]$", "example" : null } } }, "amount_allocated" : { "type" : "object", "deprecated" : false, "description" : "The amount allocated to the invoices.\n", "example" : "1200", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } }, "amount_refunded" : { "type" : "object", "deprecated" : false, "description" : "The refunds issued from this Credit Note.\n", "example" : "130", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } }, "amount_available" : { "type" : "object", "deprecated" : false, "description" : "The yet to be used credits of this Credit Note.\n", "example" : "1400", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } }, "voided_at" : { "type" : "object", "deprecated" : false, "description" : "Timestamp indicating the date and time this Credit Note gets voided.\n", "example" : "1435054328", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } }, "updated_at" : { "type" : "object", "deprecated" : false, "description" : "To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.\n", "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } }, "channel" : { "type" : "object", "deprecated" : false, "description" : "The subscription channel this object originated from and is maintained in.\n", "example" : "APP STORE", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null } } } }, "example" : null } }, "example" : null }, "encoding" : { "credit_note" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "export" : { "$ref" : "#/components/schemas/Export", "description" : "Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/coupons" : { "post" : { "summary" : "Export Coupons", "description" : "This API triggers export of coupon data. The exported zip file contains CSV files with coupon-related data.\n", "operationId" : "export_coupons", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "currency_code" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The currency code (\\[ISO 4217 format\\](https://www.chargebee.com/docs/supported-currencies.html) ) of the coupon. Applicable for \\*fixed_amount\\* coupons alone. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*currency_code\\\\\\[is\\\\\\] = \"USD\"\\*\n", "example" : "USD", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "applicable_item_price_ids" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter List of itemPrice ids for which these coupons are applicable. \\*\\*Supported operators :\\*\\* in, is \\*\\*Example →\\*\\* \\*applicable_item_price_ids\\\\\\[in\\\\\\] = \"day-pass-USD\"\\*\n", "example" : "day-pass-USD", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "coupon" : { "type" : "object", "deprecated" : false, "description" : "Parameters for coupon\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
The display name used in web interface for identifying the coupon.
\nNote:
When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.
period and period_unit. ",
"enum" : [ "one_time", "forever", "limited_period" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `one_time` - The coupon stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit. ",
"enum" : [ "one_time", "forever", "limited_period" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `one_time` - The coupon stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit. ",
"enum" : [ "one_time", "forever", "limited_period" ],
"pattern" : "^\\[(one_time|forever|limited_period)(,(one_time|forever|limited_period))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `one_time` - The coupon stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit. ",
"enum" : [ "one_time", "forever", "limited_period" ],
"pattern" : "^\\[(one_time|forever|limited_period)(,(one_time|forever|limited_period))*\\]$",
"example" : null
}
}
},
"status" : {
"type" : "object",
"deprecated" : false,
"description" : "Status of the coupon.\n",
"example" : "active",
"properties" : {
"is" : {
"type" : "string",
"description" : "* `active` - Can be applied to a subscription.\n* `expired` - Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions or valid_till date is past. Existing associations remain unaffected.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n* `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.",
"enum" : [ "active", "expired", "archived", "deleted", "future" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `active` - Can be applied to a subscription.\n* `expired` - Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions or valid_till date is past. Existing associations remain unaffected.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n* `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.",
"enum" : [ "active", "expired", "archived", "deleted", "future" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `active` - Can be applied to a subscription.\n* `expired` - Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions or valid_till date is past. Existing associations remain unaffected.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n* `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.",
"enum" : [ "active", "expired", "archived", "deleted", "future" ],
"pattern" : "^\\[(active|expired|archived|deleted|future)(,(active|expired|archived|deleted|future))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `active` - Can be applied to a subscription.\n* `expired` - Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions or valid_till date is past. Existing associations remain unaffected.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n* `future` - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.",
"enum" : [ "active", "expired", "archived", "deleted", "future" ],
"pattern" : "^\\[(active|expired|archived|deleted|future)(,(active|expired|archived|deleted|future))*\\]$",
"example" : null
}
}
},
"apply_on" : {
"type" : "object",
"deprecated" : false,
"description" : "The amount on the invoice to which the coupon is applied.\n",
"example" : "invoice_amount",
"properties" : {
"is" : {
"type" : "string",
"description" : "* `invoice_amount` - The coupon is applied to the invoice sub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nResource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/orders" : { "post" : { "summary" : "Export Orders", "description" : "This API triggers export of order data. The exported zip file contains CSV files with order-related data.\n", "operationId" : "export_orders", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "total" : { "type" : "object", "deprecated" : false, "description" : "optional, in cents filter Total amount charged for the order. \\*\\*Supported operators :\\*\\* is, is_not, lt, lte, gt, gte, between \\*\\*Example →\\*\\* \\*total\\\\\\[is\\\\\\] = \"1394532759\"\\*\n", "example" : "1394532759", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } }, "order" : { "type" : "object", "deprecated" : false, "description" : "Parameters for order\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "Uniquely identifies the order. It is the api identifier for the order\n", "example" : "3", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "subscription_id" : { "type" : "object", "deprecated" : false, "description" : "To filter based on subscription_id.\n", "example" : "3bdjnDnsdQn", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "customer_id" : { "type" : "object", "deprecated" : false, "description" : "The customer for which the order is created\n", "example" : "3bdjnDnsdQn", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "status" : { "type" : "object", "deprecated" : false, "description" : "The status of this order.\n", "example" : "paid", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`new\\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \\* \\`processing\\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \\* \\`complete\\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \\* \\`cancelled\\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \\* \\`voided\\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \\* \\`queued\\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \\* \\`awaiting_shipment\\` - The order has been picked up by an integration system, and synced to a shipping management platform \\* \\`on_hold\\` - The order is paused from being processed. \\* \\`delivered\\` - The order has been delivered to the customer. \\* \\`shipped\\` - The order has moved from order management system to a shipping system. \\* \\`partially_delivered\\` - The order has been partially delivered to the customer. \\* \\`returned\\` - The order has been returned after delivery.\n", "enum" : [ "new", "processing", "complete", "cancelled", "voided", "queued", "awaiting_shipment", "on_hold", "delivered", "shipped", "partially_delivered", "returned" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`new\\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \\* \\`processing\\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \\* \\`complete\\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \\* \\`cancelled\\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \\* \\`voided\\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \\* \\`queued\\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \\* \\`awaiting_shipment\\` - The order has been picked up by an integration system, and synced to a shipping management platform \\* \\`on_hold\\` - The order is paused from being processed. \\* \\`delivered\\` - The order has been delivered to the customer. \\* \\`shipped\\` - The order has moved from order management system to a shipping system. \\* \\`partially_delivered\\` - The order has been partially delivered to the customer. \\* \\`returned\\` - The order has been returned after delivery.\n", "enum" : [ "new", "processing", "complete", "cancelled", "voided", "queued", "awaiting_shipment", "on_hold", "delivered", "shipped", "partially_delivered", "returned" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`new\\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \\* \\`processing\\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \\* \\`complete\\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \\* \\`cancelled\\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \\* \\`voided\\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \\* \\`queued\\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \\* \\`awaiting_shipment\\` - The order has been picked up by an integration system, and synced to a shipping management platform \\* \\`on_hold\\` - The order is paused from being processed. \\* \\`delivered\\` - The order has been delivered to the customer. \\* \\`shipped\\` - The order has moved from order management system to a shipping system. \\* \\`partially_delivered\\` - The order has been partially delivered to the customer. \\* \\`returned\\` - The order has been returned after delivery.\n", "enum" : [ "new", "processing", "complete", "cancelled", "voided", "queued", "awaiting_shipment", "on_hold", "delivered", "shipped", "partially_delivered", "returned" ], "pattern" : "^\\[(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned)(,(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`new\\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \\* \\`processing\\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \\* \\`complete\\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \\* \\`cancelled\\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \\* \\`voided\\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \\* \\`queued\\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \\* \\`awaiting_shipment\\` - The order has been picked up by an integration system, and synced to a shipping management platform \\* \\`on_hold\\` - The order is paused from being processed. \\* \\`delivered\\` - The order has been delivered to the customer. \\* \\`shipped\\` - The order has moved from order management system to a shipping system. \\* \\`partially_delivered\\` - The order has been partially delivered to the customer. \\* \\`returned\\` - The order has been returned after delivery.\n", "enum" : [ "new", "processing", "complete", "cancelled", "voided", "queued", "awaiting_shipment", "on_hold", "delivered", "shipped", "partially_delivered", "returned" ], "pattern" : "^\\[(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned)(,(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned))*\\]$", "example" : null } } }, "price_type" : { "type" : "object", "deprecated" : false, "description" : "The price type of the order\n", "example" : "tax_exclusive", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "pattern" : "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "pattern" : "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\]$", "example" : null } } }, "order_date" : { "type" : "object", "deprecated" : false, "description" : "The date on which the order will start getting processed.\n", "example" : "1394532759", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } }, "shipping_date" : { "type" : "object", "deprecated" : false, "description" : "This is the date on which the order will be delivered to the customer.\n", "example" : "1394532759", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } }, "shipped_at" : { "type" : "object", "deprecated" : false, "description" : "The time at which the order was shipped.\n", "example" : "1394532759", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } }, "delivered_at" : { "type" : "object", "deprecated" : false, "description" : "The time at which the order was delivered\n", "example" : "1394532759", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } }, "cancelled_at" : { "type" : "object", "deprecated" : false, "description" : "The time at which the order was cancelled.\n", "example" : "1394532759", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } }, "amount_paid" : { "type" : "object", "deprecated" : false, "description" : "Total amount paid for the order.\n", "example" : "1000", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } }, "refundable_credits" : { "type" : "object", "deprecated" : false, "description" : "The total amount that can be issued as credits for this order.\n", "example" : "1000", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } }, "refundable_credits_issued" : { "type" : "object", "deprecated" : false, "description" : "The total amount issued as credits on behalf of this order.\n", "example" : "1000", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } }, "updated_at" : { "type" : "object", "deprecated" : false, "description" : "Filter based on the time at which order has been updated.\n", "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } }, "resent_status" : { "type" : "object", "deprecated" : false, "description" : "Resent order status.\n", "example" : "fully_resent", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`fully_resent\\` - Order is Fully resent \\* \\`partially_resent\\` - Order is Partially resent\n", "enum" : [ "fully_resent", "partially_resent" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`fully_resent\\` - Order is Fully resent \\* \\`partially_resent\\` - Order is Partially resent\n", "enum" : [ "fully_resent", "partially_resent" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`fully_resent\\` - Order is Fully resent \\* \\`partially_resent\\` - Order is Partially resent\n", "enum" : [ "fully_resent", "partially_resent" ], "pattern" : "^\\[(fully_resent|partially_resent)(,(fully_resent|partially_resent))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`fully_resent\\` - Order is Fully resent \\* \\`partially_resent\\` - Order is Partially resent\n", "enum" : [ "fully_resent", "partially_resent" ], "pattern" : "^\\[(fully_resent|partially_resent)(,(fully_resent|partially_resent))*\\]$", "example" : null } } }, "is_resent" : { "type" : "object", "deprecated" : false, "description" : "Order is resent order or not.\n", "example" : "false", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } }, "original_order_id" : { "type" : "object", "deprecated" : false, "description" : "If resent order what is the parent order id.\n", "example" : "1243545465", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } } } }, "example" : null } }, "example" : null }, "encoding" : { "order" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "export" : { "$ref" : "#/components/schemas/Export", "description" : "Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/item_prices" : { "post" : { "summary" : "Export Item Prices", "description" : "This API triggers export of item price data. The exported zip file contains CSV files with item price-related data.\n", "operationId" : "export_item_prices", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "item_family_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter
\nFilter item prices based on item_family_id\n.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nitem_family_id[is] = "Acme"
", "example" : "Acme", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "item_type" : { "type" : "object", "deprecated" : false, "description" : "optional, enumerated string filter
\nFilter item prices based on item_type.\nPossible values are : plan, addon, charge.
Supported operators :\nis, is_not, in, not_in
\nExample →\nitem_type[is_not] = "plan"
", "example" : "plan", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "pattern" : "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "pattern" : "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$", "example" : null } } }, "currency_code" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter
\nFilter item prices based on their currency_code\n.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\ncurrency_code[is] = "USD"
", "example" : "USD", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "business_entity_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter
\nThe unique ID of the\nbusiness entity\nof this item_price.\nLearn more\nabout all the scenarios before using this filter.
Supported operators :\nis, is_present
\nExample →\nbusiness_entity_id[is_present] = "true"
", "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "description" : "null\n", "enum" : [ "true", "false" ], "example" : null } } }, "include_site_level_resources" : { "type" : "object", "deprecated" : false, "description" : "optional, boolean filter
\nDefault value is true . To exclude site-level resources in specific cases, set this parameter to false.\nPossible values are : true, false
Supported operators :\nis
\nExample →\ninclude_site_level_resources[is] = "null"
", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null }, "item_price" : { "type" : "object", "deprecated" : false, "description" : "Parameters for item_price\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "Filter item prices based on their \\[id\\](/docs/api/exports) .\n", "example" : "basic_USD", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "name" : { "type" : "object", "deprecated" : false, "description" : "Filter item prices based on their name\ns.
Filter item prices based on their pricing_model\n.
Filter item prices based on their item_id\n.
Filter item prices based on their price_variant_id\n.
Filter item prices based on their trial_period\n.
Filter item prices based on their trial_period_unit\n.
Filter item prices based on their status\n.
id and name can be reused.",
"enum" : [ "active", "archived", "deleted" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `active` - The item price can be used in subscriptions.\n* `archived` - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.\n* `deleted` - Indicates that the item price has been deleted. The id and name can be reused.",
"enum" : [ "active", "archived", "deleted" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `active` - The item price can be used in subscriptions.\n* `archived` - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.\n* `deleted` - Indicates that the item price has been deleted. The id and name can be reused.",
"enum" : [ "active", "archived", "deleted" ],
"pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `active` - The item price can be used in subscriptions.\n* `archived` - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.\n* `deleted` - Indicates that the item price has been deleted. The id and name can be reused.",
"enum" : [ "active", "archived", "deleted" ],
"pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
"example" : null
}
}
},
"updated_at" : {
"type" : "object",
"deprecated" : false,
"description" : "Filter item prices based on their updated_at\n.
Filter item prices based on their period_unit\n.
Filter item prices based on their period\n.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/subscriptions" : { "post" : { "summary" : "Export Subscriptions", "description" : "This API triggers export of subscription data. The exported zip file contains CSV files with subscription-related data.\n", "operationId" : "export_subscriptions", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "export_type" : { "type" : "string", "default" : "data", "deprecated" : false, "description" : "Determines the format of the data. Returns the export type based on the selected value.\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\\* data -\n\nDownload your current data in CSV.\n", "enum" : [ "data", "import_friendly_data" ], "example" : null }, "item_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The plan item code. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*item_id\\\\\\[is\\\\\\] = \"silver\"\\*\n", "example" : "silver", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "item_price_id" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The plan item price code. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*item_price_id\\\\\\[is\\\\\\] = \"silver-USD-monthly\"\\*\n", "example" : "silver-USD-monthly", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "cancel_reason_code" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in \\*\\*Settings \\\\\\> Configure Chargebee \\\\\\> Reason Codes \\\\\\> Subscriptions \\\\\\> Subscription Cancellation\\*\\* . Must be passed if set as mandatory in the app. The codes are case-sensitive. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*cancel_reason_code\\\\\\[is\\\\\\] = \"Not Paid\"\\*\n", "example" : "Not Paid", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "subscription" : { "type" : "object", "deprecated" : false, "description" : "Parameters for subscription\n", "properties" : { "id" : { "type" : "object", "deprecated" : false, "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n", "example" : "8gsnbYfsMLds", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "customer_id" : { "type" : "object", "deprecated" : false, "description" : "Identifier of the customer with whom this subscription is associated.\n", "example" : "8gsnbYfsMLds", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } }, "status" : { "type" : "object", "deprecated" : false, "description" : "Current state of the subscription\n", "example" : "active", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`future\\` - The subscription is scheduled to start at a future date. \\* \\`in_trial\\` - The subscription is in trial. \\* \\`active\\` - The subscription is active and will be charged for automatically based on the items in it. \\* \\`non_renewing\\` - The subscription will be canceled at the end of the current term. \\* \\`paused\\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \\* \\`cancelled\\` - The subscription has been canceled and is no longer in service. \\* \\`transferred\\` - The subscription has been transferred to another business entity within the organization.\n", "enum" : [ "future", "in_trial", "active", "non_renewing", "paused", "cancelled", "transferred" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`future\\` - The subscription is scheduled to start at a future date. \\* \\`in_trial\\` - The subscription is in trial. \\* \\`active\\` - The subscription is active and will be charged for automatically based on the items in it. \\* \\`non_renewing\\` - The subscription will be canceled at the end of the current term. \\* \\`paused\\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \\* \\`cancelled\\` - The subscription has been canceled and is no longer in service. \\* \\`transferred\\` - The subscription has been transferred to another business entity within the organization.\n", "enum" : [ "future", "in_trial", "active", "non_renewing", "paused", "cancelled", "transferred" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`future\\` - The subscription is scheduled to start at a future date. \\* \\`in_trial\\` - The subscription is in trial. \\* \\`active\\` - The subscription is active and will be charged for automatically based on the items in it. \\* \\`non_renewing\\` - The subscription will be canceled at the end of the current term. \\* \\`paused\\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \\* \\`cancelled\\` - The subscription has been canceled and is no longer in service. \\* \\`transferred\\` - The subscription has been transferred to another business entity within the organization.\n", "enum" : [ "future", "in_trial", "active", "non_renewing", "paused", "cancelled", "transferred" ], "pattern" : "^\\[(future|in_trial|active|non_renewing|paused|cancelled|transferred)(,(future|in_trial|active|non_renewing|paused|cancelled|transferred))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`future\\` - The subscription is scheduled to start at a future date. \\* \\`in_trial\\` - The subscription is in trial. \\* \\`active\\` - The subscription is active and will be charged for automatically based on the items in it. \\* \\`non_renewing\\` - The subscription will be canceled at the end of the current term. \\* \\`paused\\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \\* \\`cancelled\\` - The subscription has been canceled and is no longer in service. \\* \\`transferred\\` - The subscription has been transferred to another business entity within the organization.\n", "enum" : [ "future", "in_trial", "active", "non_renewing", "paused", "cancelled", "transferred" ], "pattern" : "^\\[(future|in_trial|active|non_renewing|paused|cancelled|transferred)(,(future|in_trial|active|non_renewing|paused|cancelled|transferred))*\\]$", "example" : null } } }, "cancel_reason" : { "type" : "object", "deprecated" : false, "description" : "The reason for canceling the subscription. Set by Chargebee automatically.\n", "example" : "not_paid", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`not_paid\\` - Not Paid \\* \\`no_card\\` - No Card \\* \\`fraud_review_failed\\` - Fraud Review Failed \\* \\`non_compliant_eu_customer\\` - Non Compliant EU Customer \\* \\`tax_calculation_failed\\` - Tax Calculation Failed \\* \\`currency_incompatible_with_gateway\\` - Currency incompatible with Gateway \\* \\`non_compliant_customer\\` - Non Compliant Customer\n", "enum" : [ "not_paid", "no_card", "fraud_review_failed", "non_compliant_eu_customer", "tax_calculation_failed", "currency_incompatible_with_gateway", "non_compliant_customer" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`not_paid\\` - Not Paid \\* \\`no_card\\` - No Card \\* \\`fraud_review_failed\\` - Fraud Review Failed \\* \\`non_compliant_eu_customer\\` - Non Compliant EU Customer \\* \\`tax_calculation_failed\\` - Tax Calculation Failed \\* \\`currency_incompatible_with_gateway\\` - Currency incompatible with Gateway \\* \\`non_compliant_customer\\` - Non Compliant Customer\n", "enum" : [ "not_paid", "no_card", "fraud_review_failed", "non_compliant_eu_customer", "tax_calculation_failed", "currency_incompatible_with_gateway", "non_compliant_customer" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`not_paid\\` - Not Paid \\* \\`no_card\\` - No Card \\* \\`fraud_review_failed\\` - Fraud Review Failed \\* \\`non_compliant_eu_customer\\` - Non Compliant EU Customer \\* \\`tax_calculation_failed\\` - Tax Calculation Failed \\* \\`currency_incompatible_with_gateway\\` - Currency incompatible with Gateway \\* \\`non_compliant_customer\\` - Non Compliant Customer\n", "enum" : [ "not_paid", "no_card", "fraud_review_failed", "non_compliant_eu_customer", "tax_calculation_failed", "currency_incompatible_with_gateway", "non_compliant_customer" ], "pattern" : "^\\[(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer)(,(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`not_paid\\` - Not Paid \\* \\`no_card\\` - No Card \\* \\`fraud_review_failed\\` - Fraud Review Failed \\* \\`non_compliant_eu_customer\\` - Non Compliant EU Customer \\* \\`tax_calculation_failed\\` - Tax Calculation Failed \\* \\`currency_incompatible_with_gateway\\` - Currency incompatible with Gateway \\* \\`non_compliant_customer\\` - Non Compliant Customer\n", "enum" : [ "not_paid", "no_card", "fraud_review_failed", "non_compliant_eu_customer", "tax_calculation_failed", "currency_incompatible_with_gateway", "non_compliant_customer" ], "pattern" : "^\\[(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer)(,(not_paid|no_card|fraud_review_failed|non_compliant_eu_customer|tax_calculation_failed|currency_incompatible_with_gateway|non_compliant_customer))*\\]$", "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } }, "remaining_billing_cycles" : { "type" : "object", "deprecated" : false, "description" : "\\* When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels. \\* When the subscription is on a \\[contract term\\](/docs/api/contract_terms): this value is the number of billing cycles remaining in the contract term after the current billing cycle.\n", "example" : "3", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } }, "created_at" : { "type" : "object", "deprecated" : false, "description" : "The time at which the subscription was created.\n", "example" : "1435054328", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } }, "activated_at" : { "type" : "object", "deprecated" : false, "description" : "Time at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.
The date/time at which the next billing for the subscription happens. This is usually right after current_term_end\nunless multiple subscription terms were invoiced in advance using the terms_to_charge\nparameter.
If true\n, there are subscription changes scheduled on next renewal.
To filter based on updated_at.\nThis attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by\ninput parameter as updated_at\nfor a faster response.
Set to false\nto override for this subscription, the site-level setting\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level\n.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/full_exports/status" : { "get" : { "summary" : "Retrieve full export status", "description" : "This endpoint retrieves the status of your data export request.\n", "operationId" : "retrieve_full_export_status", "parameters" : [ { "name" : "table", "in" : "query", "description" : "The name of the table for which the export status is to be retrieved. For example, invoices.\n", "required" : true, "deprecated" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "deprecated" : false, "maxLength" : 200, "example" : null } }, { "name" : "date", "in" : "query", "description" : "The date for which the export status is required, formatted in YYYY-MM-DD format. For example, 2023-08-29.\n", "required" : true, "deprecated" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date", "deprecated" : false, "example" : null } }, { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "full_export" : { "$ref" : "#/components/schemas/FullExport", "description" : "Resource object representing full_export
" } }, "required" : [ "full_export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_intents/{payment-intent-id}" : { "get" : { "summary" : "Retrieve a payment intent", "description" : "Retrieves the PaymentIntent resource.\n", "operationId" : "retrieve_a_payment_intent", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "payment-intent-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/payment-intent-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "payment_intent" : { "$ref" : "#/components/schemas/PaymentIntent", "description" : "Resource object representing payment_intent
" } }, "required" : [ "payment_intent" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a payment intent", "description" : "Updating properties on a PaymentIntent object. All the subsequent 3DS transaction attempts will have the updated values.\n", "operationId" : "update_a_payment_intent", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "payment-intent-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/payment-intent-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Amount(in cents) to be authorized for 3DS flow.\n", "minimum" : 0, "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "The currency code (ISO 4217 format) of the amount used in transaction.\n", "maxLength" : 3, "example" : null }, "gateway_account_id" : { "type" : "string", "deprecated" : false, "description" : "The gateway account used for performing the 3DS flow.\n", "maxLength" : 50, "example" : null }, "payment_method_type" : { "type" : "string", "default" : "card", "deprecated" : false, "description" : "The payment method of this intent.\n\\* google_pay -\n\ngoogle_pay\n\\* pay_co -\n\nPayments made via PayCo\n\\* boleto -\n\nboleto\n\\* apple_pay -\n\napple_pay\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\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\\* ideal -\n\nideal\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* amazon_payments -\n\nAmazon Payments\n\\* bancontact -\n\nbancontact\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* grab_pay -\n\nPayments made via GrabPay\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\\* card -\n\ncard\n\\* dotpay -\n\ndotpay\n\\* giropay -\n\ngiropay\n\\* upi -\n\nupi\n\\* sofort -\n\nsofort\n\\* sepa_instant_transfer -\n\nSepa Instant Transfer\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\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\ndirect_debit\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\\* paypal_express_checkout -\n\npaypal_express_checkout\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" ], "example" : null }, "success_url" : { "type" : "string", "deprecated" : false, "description" : "The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.
The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.
Resource object representing payment_intent
" } }, "required" : [ "payment_intent" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_intents" : { "post" : { "summary" : "Create a payment intent", "description" : "Creates a PaymentIntent object. This is to be used with Chargebee.js API to complete the 3DS flow for new or stored cards.
While creating, specify the appropriate gateway account and amount. Exact amount can be estimated using our Estimate API.
When customer[id] is provided for this operation, it is looked up by Chargebee, and if found, the payment_intent is created for it. If not found, the payment_intent is created without any customer association and will be available for any customer.
If multiple business entities are created for the site, the customer resource lookup and creation happen within the context of the business entity specified in this API call. If no business entity is specified, the customer resource lookup is performed within the site context, and if not found, the resource is created for the default business entity of the site.
The unique identifier of the customer for whom the payment_intent will be created. If specified, the payment_intent will be used exclusively for that customer. If not specified, the payment_intent won't be associated with any customer and will be available for any customer.
See also
The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.
The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.
Resource object representing payment_intent
" } }, "required" : [ "payment_intent" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/custom_field_configs/retrieve" : { "get" : { "summary" : "Retrieve a custom field configuration", "description" : "Retrieves the configuration for the [custom field](/docs/api/advanced-features#custom-fields) that matches the specified entity type and API name.\n", "operationId" : "retrieve_the_meta_data", "parameters" : [ { "name" : "entity_type", "in" : "query", "description" : "Allowed entity types for custom fields.\n\\* customer -\n\nEntity that represents a customer.\n\\* invoice -\n\nEntity that represents an invoice.\n\\* addon_item -\n\nEntity that represents item of type addon.\n\\* plan -\n\nEntity that represents a subscription plan.\n\\* subscription -\n\nEntity that represents a subscription of a customer.\n\\* coupon -\n\nEntity that represents a discount coupon.\n\\* charge_price -\n\nEntity that represents charge price.\n\\* item_family -\n\nEntity that represents item family.\n\\* addon -\n\nEntity that represents an addon.\n\\* addon_price -\n\nEntity that represents addon price.\n\\* credit_note -\n\nEntity that represents a credit note.\n\\* charge_item -\n\nEntity that represents item of type charge.\n\\* plan_item -\n\nEntity that represents item of type plan.\n\\* quote -\n\nEntity that represents a quote.\n\\* plan_price -\n\nEntity that represents plan price.\n", "required" : true, "deprecated" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "deprecated" : false, "enum" : [ "customer", "subscription", "plan", "addon", "invoice", "credit_note", "item_family", "plan_item", "addon_item", "charge_item", "plan_price", "addon_price", "charge_price", "coupon", "quote" ], "example" : null } }, { "name" : "api_name", "in" : "query", "description" : "Custom field identifier.\n", "required" : true, "deprecated" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null } }, { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "custom_field_config" : { "$ref" : "#/components/schemas/CustomFieldConfig", "description" : "Resource object representing custom_field_config.
" } }, "required" : [ "custom_field_config" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/custom_field_configs" : { "get" : { "summary" : "List custom field configurations", "description" : "Lists the configurations for all [custom fields](/docs/api/advanced-features#custom-fields) defined for the specified entity type.\n", "operationId" : "list_custom_field_configs", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Deletes an item family, marking its status\nas deleted\n. This is not allowed if there are active\nitems under the item family. Once deleted, the id\nand name\nof the item family can be reused to create a new item family.
Resource object representing item_family
" } }, "required" : [ "item_family" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/item_families" : { "get" : { "summary" : "List item families", "description" : "Returns a list of item families satisfying **all**\nthe conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.\n", "operationId" : "list_item_families", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, string filter
\nThe unique ID of the\nbusiness entity\nof this item_family.\nLearn more\nabout all the scenarios before using this filter.
Supported operators :\nis, is_present
\nExample →\nbusiness_entity_id[is_present] = "true"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "include_site_level_resources", "in" : "query", "description" : "optional, boolean filter
\nDefault value is true . To exclude site-level resources in specific cases, set this parameter to false.\nPossible values are : true, false
Supported operators :\nis
\nExample →\ninclude_site_level_resources[is] = "null"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "item_family" : { "$ref" : "#/components/schemas/ItemFamily", "description" : "Resource object representing item_family" } }, "required" : [ "item_family" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Create an item family", "description" : "This endpoint creates an item family for your product line or service.\n", "operationId" : "create_an_item_family", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "The identifier for the item family. Must be unique and is immutable.\n", "maxLength" : 50, "example" : null }, "name" : { "type" : "string", "deprecated" : false, "description" : "The display name for the item family. Must be unique. This is visible only in Chargebee and not to customers.\n", "maxLength" : 50, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "Description of the item family. This is visible only in Chargebee and not to customers.\n", "maxLength" : 500, "example" : null }, "business_entity_id" : { "type" : "string", "deprecated" : false, "description" : "The unique ID of the business entity\nfor this item_family.\nThis is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the business_entity_id\nwill not be included in the API response.
Note\nAn alternative way of passing this parameter is by means of a custom HTTP header.
Resource object representing item_family
" } }, "required" : [ "item_family" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/item_families/{item-family-id}" : { "get" : { "summary" : "Retrieve an item family", "description" : "This endpoint retrieves an item family based on the item family id.\n", "operationId" : "retrieve_an_item_family", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "item-family-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/item-family-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "item_family" : { "$ref" : "#/components/schemas/ItemFamily", "description" : "Resource object representing item_family
" } }, "required" : [ "item_family" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update an item family", "description" : "This endpoint updates the name and/or description of the item family.\n", "operationId" : "update_an_item_family", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "item-family-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/item-family-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "name" : { "type" : "string", "deprecated" : false, "description" : "The display name for the item family. Must be unique. This is visible only in Chargebee and not to customers.\n", "maxLength" : 50, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "Description of the item family. This is visible only in Chargebee and not to customers.\n", "maxLength" : 500, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "item_family" : { "$ref" : "#/components/schemas/ItemFamily", "description" : "Resource object representing item_family
" } }, "required" : [ "item_family" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/products/{product-id}" : { "get" : { "summary" : "Retrieve a product", "description" : "Retrieve a product using product_id\n.
Resource object representing product
" } }, "required" : [ "product" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a product", "description" : "This API allows you to update specific product details.\n\nThe following table will help you to understand the status of the mapped [item](/docs/api/items/item-object#status) and [item_price](/docs/api/item_prices/item_price-object#status) after passing product [status](/docs/api/products/update-a-product#status) value during product updation. \n\n|-------------------------------------|--------------------------------|\n| **Product Status**(Input parameter) | **Item and Item Price Status** |\n| **active** | **active** |\n| **inactive** | **archived** |\n\n", "operationId" : "update_a_product", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "product-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/product-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "string", "deprecated" : false, "description" : "A unique internal name for the product. This is only visible in Chargebee.\n", "maxLength" : 100, "example" : null }, "external_name" : { "type" : "string", "deprecated" : false, "description" : "The unique name that appears for each product to the end user.\n", "maxLength" : 100, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "Description of the product.\n", "maxLength" : 500, "example" : null }, "status" : { "type" : "string", "default" : "active", "deprecated" : false, "description" : "Status of the product. Refer to the [table](/docs/api/products/update-a-product)\nfor more information.\n\\* active -\n\nThe active products are visible on the storefront, subscription, or checkout.\n\\* inactive -\n\nThe inactive products are not visible on the storefront, subscription, or checkout.\n", "enum" : [ "active", "inactive" ], "example" : null }, "sku" : { "type" : "string", "deprecated" : false, "description" : "A unique identifier code a seller assigns to each product or item. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.\n", "maxLength" : 100, "example" : null }, "shippable" : { "type" : "boolean", "default" : true, "deprecated" : false, "description" : "Whether a product is shippable or not. Pass the value as true\nif it is a shippable physical product, else pass the value as false\n.
Resource object representing product
" } }, "required" : [ "product" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/products/{product-id}/delete" : { "post" : { "summary" : "Delete a product", "description" : "This API deletes a product and changes the delete attribute value to true\n. Deletion of a product is not allowed if there are active\nor archived\nvariants under the product or if there are items mapped to the product. Once deleted, the name\nof the product can be reused.
Resource object representing product
" } }, "required" : [ "product" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/products/{product-id}/update_options" : { "post" : { "summary" : "Add remove or update options for the product", "description" : "This API allows you to add, remove, or update product options.\n", "operationId" : "add_remove_or_update_options_for_the_product", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "product-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/product-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "remove_options" : { "type" : "array", "deprecated" : false, "description" : "List of options that you want to remove from the product. You can provide option names.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "options" : { "type" : "object", "deprecated" : false, "description" : "The list of options that you want to add when the options[name]\nare absent in a product, you can use this parameter to update the option values that already exist in a product.
Resource object representing product
" } }, "required" : [ "product" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/products" : { "get" : { "summary" : "List products", "description" : "This API retrieves the list of products that are active\nor inactive\n. Use include_deleted\nparameter to include deleted products with active\nand inactive\nproducts.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, string filter
\nFilter product based on their name\ns.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nname[is] = "basic"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "status", "in" : "query", "description" : "optional, enumerated string filter
\nFilter product based on their status.\nPossible values are : active, inactive.
Supported operators :\nis, is_not, in, not_in
\nExample →\nstatus[is] = "basic"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`active\\` - active \\* \\`inactive\\` - inactive\n", "enum" : [ "active", "inactive" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`active\\` - active \\* \\`inactive\\` - inactive\n", "enum" : [ "active", "inactive" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`active\\` - active \\* \\`inactive\\` - inactive\n", "enum" : [ "active", "inactive" ], "pattern" : "^\\[(active|inactive)(,(active|inactive))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`active\\` - active \\* \\`inactive\\` - inactive\n", "enum" : [ "active", "inactive" ], "pattern" : "^\\[(active|inactive)(,(active|inactive))*\\]$", "example" : null } } } }, { "name" : "shippable", "in" : "query", "description" : "optional, boolean filter\n\nFilter product based on whether it is shippable or not. Possible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*shippable\\[is\\] = \"true\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "true", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "has_variant", "in" : "query", "description" : "optional, boolean filter\n\nFilter product based on whether it has variants or not. Possible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*has_variant\\[is\\] = \"true\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "true", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "created_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\nFilter product based on their created time\n.\nSupported operators :\nafter, before, on, between
Example →\ncreated_at[after] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "updated_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\nFilter product based on their updated time\n.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[after] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\nname, id, created_at, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"name\"*\n\nThis will sort the result based on the 'name' attribute in ascending(earliest first) order.\n", "required" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "asc" : { "type" : "string", "enum" : [ "name", "id", "created_at", "updated_at" ], "example" : null }, "desc" : { "type" : "string", "enum" : [ "name", "id", "created_at", "updated_at" ], "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "product" : { "$ref" : "#/components/schemas/Product", "description" : "Resource object representing product" } }, "required" : [ "product" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Create a product", "description" : "This API creates a new product.\n", "operationId" : "create_a_product", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "string", "deprecated" : false, "description" : "A unique internal name for the product. This is only visible in Chargebee.\n", "maxLength" : 100, "example" : null }, "external_name" : { "type" : "string", "deprecated" : false, "description" : "The unique name that appears to the end user for each product.\n", "maxLength" : 100, "example" : null }, "status" : { "type" : "string", "default" : "active", "deprecated" : false, "description" : "Status of the product.\n\\* active -\n\nThe active products are visible on the storefront, subscription, or checkout.\n\\* inactive -\n\nThe inactive products are not visible on the storefront, subscription, or checkout.\n", "enum" : [ "active", "inactive" ], "example" : null }, "id" : { "type" : "string", "deprecated" : false, "description" : "The immutable unique identifier of the product. If not passed, it will get autogenerated.\n", "maxLength" : 100, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "Description of the product.\n", "maxLength" : 500, "example" : null }, "sku" : { "type" : "string", "deprecated" : false, "description" : "A unique identifier code a seller assigns to each product or item. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.\n", "maxLength" : 100, "example" : null }, "metadata" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "A collection of key-value pairs that provides extra information about the product. \\*\\*Note:\\*\\* There's a character limit of 65,535. \\[Learn more\\](/docs/api/advanced-features#metadata) .\n", "example" : null }, "shippable" : { "type" : "boolean", "default" : true, "deprecated" : false, "description" : "Whether a product is shippable or not. Pass the value as true\nif it is a shippable physical product, else pass the value as false\n.
Resource object representing product
" } }, "required" : [ "product" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/products/{product-id}/variants" : { "get" : { "summary" : "List product variants", "description" : "This API retrieves the list of product variants.\n", "operationId" : "list_product_variants", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "product-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/product-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, string filter
\nFilter variant based on their name\ns.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nname[is] = "basic"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "sku", "in" : "query", "description" : "optional, string filter
\nFilter variant based on their sku\n.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nsku[is] = "basic"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "status", "in" : "query", "description" : "optional, enumerated string filter
\nFilter variant based on their status.\nPossible values are : active, inactive.
Supported operators :\nis, is_not, in, not_in
\nExample →\nstatus[is] = "active"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "active", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`active\\` - active \\* \\`inactive\\` - inactive\n", "enum" : [ "active", "inactive" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`active\\` - active \\* \\`inactive\\` - inactive\n", "enum" : [ "active", "inactive" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`active\\` - active \\* \\`inactive\\` - inactive\n", "enum" : [ "active", "inactive" ], "pattern" : "^\\[(active|inactive)(,(active|inactive))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`active\\` - active \\* \\`inactive\\` - inactive\n", "enum" : [ "active", "inactive" ], "pattern" : "^\\[(active|inactive)(,(active|inactive))*\\]$", "example" : null } } } }, { "name" : "updated_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\nFilter product based on their updated time\n.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[before] = "basic"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "created_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\nFilter product based on their created time\n.\nSupported operators :\nafter, before, on, between
Example →\ncreated_at[before] = "basic"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\nname, id, status, created_at, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"name\"*\n\nThis will sort the result based on the 'name' attribute in ascending(earliest first) order.\n", "required" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "asc" : { "type" : "string", "enum" : [ "name", "id", "status", "created_at", "updated_at" ], "example" : null }, "desc" : { "type" : "string", "enum" : [ "name", "id", "status", "created_at", "updated_at" ], "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "variant" : { "$ref" : "#/components/schemas/Variant", "description" : "Resource object representing variant" } }, "required" : [ "variant" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Create a product variant", "description" : "This API is used for creating a new product variant.\nThe following table will help you to understand the state of the variant status after passing status value during variant creation.
Parameter Value column holds possible inputs to the variant.status.
Product Status column states the status of the associated product.
\nVariant Status column states the value of the variant status once the variant is created.
\n| Parameter Value | Product Status | Variant Status |
| No value passed | active | active |
| No value passed | inactive | inactive |
| Value passed as active | active | active |
| Value passed as inactive | active | inactive |
| Value passed as active | inactive | not allowed |
| Value passed as inactive | inactive | inactive |
Pass values of the option_values
Resource object representing variant
" } }, "required" : [ "variant" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/variants/{product-variant-id}" : { "get" : { "summary" : "Retrieve a product variant", "description" : "This API is used to retrieve a product variant using variant_id\n.
Resource object representing variant
" } }, "required" : [ "variant" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a product variant", "description" : "This API is used to modify a product variant.\n", "operationId" : "update_a_product_variant", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "product-variant-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/product-variant-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "string", "deprecated" : false, "description" : "This is a unique name that appears for each product variant to the end user.\n", "maxLength" : 100, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "A detailed description of this product variant.\n", "maxLength" : 500, "example" : null }, "status" : { "type" : "string", "deprecated" : false, "description" : "Status of the product variant.\n\\* active -\n\nThe active product variants are visible on the storefront, subscription, or checkout.\n\\* inactive -\n\nThe inactive product variants are not visible on the storefront, subscription, or checkout.\n", "enum" : [ "active", "inactive" ], "example" : null }, "external_name" : { "type" : "string", "deprecated" : false, "description" : "The unique name that appears for each product variant to the end user.\n", "maxLength" : 100, "example" : null }, "sku" : { "type" : "string", "deprecated" : false, "description" : "A unique identifier code a seller assigns to each product variant. Retailers and merchants use SKUs to keep track of inventory and sales data and help organize products within a store or warehouse. SKUs can include a combination of letters, numbers, and symbols and can vary in length depending on the seller's needs.\n", "maxLength" : 100, "example" : null }, "metadata" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "A collection of key-value pairs that provides extra information about the variant. \\*\\*Note:\\*\\* There's a character limit of 65,535. \\[Learn more\\](/docs/api/advanced-features#metadata) .\n", "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "variant" : { "$ref" : "#/components/schemas/Variant", "description" : "Resource object representing variant
" } }, "required" : [ "variant" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/variants/{product-variant-id}/delete" : { "post" : { "summary" : "Delete a product variant", "description" : "This API deletes a product variant and returns the delete attribute value as true\n. Deletion of a product variant is not allowed if there are active\nor archived\nitem_price_id\nunder the variant. Once the variant is deleted, the id\nand name\nof the product variant can be reused.
Resource object representing variant
" } }, "required" : [ "variant" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/items" : { "get" : { "summary" : "List items", "description" : "Returns a list of items satisfying **all**\nthe conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.\n", "operationId" : "list_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, string filter
\nFilter items based on item_family_id\n.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nitem_family_id[is] = "acme"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "acme", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "type", "in" : "query", "description" : "optional, enumerated string filter
\nFilter items based on item type.\nPossible values are : plan, addon, charge.
Supported operators :\nis, is_not, in, not_in
\nExample →\ntype[is] = "plan"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "plan", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "pattern" : "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "pattern" : "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$", "example" : null } } } }, { "name" : "name", "in" : "query", "description" : "optional, string filter
\nFilter items based on item name\n.\nSupported operators :\nis, is_not, starts_with
Example →\nname[is_not] = "basic"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } } } }, { "name" : "item_applicability", "in" : "query", "description" : "optional, enumerated string filter
\nFilter items based on item_applicability.\nPossible values are : all, restricted.
Supported operators :\nis, is_not, in, not_in
\nExample →\nitem_applicability[is_not] = "all"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "all", "properties" : { "is" : { "type" : "string", "description" : "* `all` - all addon-items and charge-items are applicable to this plan-item.\n* `restricted` - only the addon-items or charge-items provided inapplicable_items can be applied to this plan-item.",
"enum" : [ "all", "restricted" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `all` - all addon-items and charge-items are applicable to this plan-item.\n* `restricted` - only the addon-items or charge-items provided in applicable_items can be applied to this plan-item.",
"enum" : [ "all", "restricted" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `all` - all addon-items and charge-items are applicable to this plan-item.\n* `restricted` - only the addon-items or charge-items provided in applicable_items can be applied to this plan-item.",
"enum" : [ "all", "restricted" ],
"pattern" : "^\\[(all|restricted)(,(all|restricted))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `all` - all addon-items and charge-items are applicable to this plan-item.\n* `restricted` - only the addon-items or charge-items provided in applicable_items can be applied to this plan-item.",
"enum" : [ "all", "restricted" ],
"pattern" : "^\\[(all|restricted)(,(all|restricted))*\\]$",
"example" : null
}
}
}
}, {
"name" : "status",
"in" : "query",
"description" : "optional, enumerated string filter
\nFilter items based on item status.\nPossible values are : active, archived.
Supported operators :\nis, is_not, in, not_in
\nExample →\nstatus[is] = "active"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "active", "properties" : { "is" : { "type" : "string", "description" : "* `active` - The item can be used to create new item prices.\n* `archived` - The item is no longer active and no new item prices can be created\n* `deleted` - Indicates that the item has been deleted. Theid and name can be reused. Deleted items can be retrieved using List items.",
"enum" : [ "active", "archived", "deleted" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `active` - The item can be used to create new item prices.\n* `archived` - The item is no longer active and no new item prices can be created\n* `deleted` - Indicates that the item has been deleted. The id and name can be reused. Deleted items can be retrieved using List items.",
"enum" : [ "active", "archived", "deleted" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `active` - The item can be used to create new item prices.\n* `archived` - The item is no longer active and no new item prices can be created\n* `deleted` - Indicates that the item has been deleted. The id and name can be reused. Deleted items can be retrieved using List items.",
"enum" : [ "active", "archived", "deleted" ],
"pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `active` - The item can be used to create new item prices.\n* `archived` - The item is no longer active and no new item prices can be created\n* `deleted` - Indicates that the item has been deleted. The id and name can be reused. Deleted items can be retrieved using List items.",
"enum" : [ "active", "archived", "deleted" ],
"pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
"example" : null
}
}
}
}, {
"name" : "is_giftable",
"in" : "query",
"description" : "optional, boolean filter\n\nSpecifies if gift subscriptions can be created for this item. Possible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*is_giftable\\[is\\] = \"true\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "true",
"properties" : {
"is" : {
"type" : "string",
"format" : "boolean",
"enum" : [ "true", "false" ],
"example" : null
}
}
}
}, {
"name" : "updated_at",
"in" : "query",
"description" : "optional, timestamp(UTC) in seconds filter\n\nFilter items based on when the items were last updated.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[after\\] = \"1243545465\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "1243545465",
"properties" : {
"after" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"before" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"on" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"between" : {
"type" : "string",
"pattern" : "^\\[\\d{10},\\d{10}\\]$",
"example" : null
}
}
}
}, {
"name" : "enabled_for_checkout",
"in" : "query",
"description" : "optional, boolean filter\n\nAllow the plan to subscribed to via Checkout. Applies only for plan-items.\n**Note:**\nOnly the in-app layout of Checkout is supported. Possible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*enabled_for_checkout\\[is\\] = \"null\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"properties" : {
"is" : {
"type" : "string",
"format" : "boolean",
"enum" : [ "true", "false" ],
"example" : null
}
},
"example" : null
}
}, {
"name" : "enabled_in_portal",
"in" : "query",
"description" : "optional, boolean filter\n\nAllow customers to change their subscription to this plan via the [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html).\nApplies only for plan-items. This requires the Portal configuration to [allow changing subscriptions](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription).\nPossible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*enabled_in_portal\\[is\\] = \"null\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"properties" : {
"is" : {
"type" : "string",
"format" : "boolean",
"enum" : [ "true", "false" ],
"example" : null
}
},
"example" : null
}
}, {
"name" : "metered",
"in" : "query",
"description" : "optional, boolean filter
\nSpecifies whether the item undergoes metered billing. When true\n, the quantity is calculated from usage records.\nWhen false\n, the quantity\nis as determined while adding an item price to the subscription. Applicable only for items of type\nplan\nor addon\nand when Metered Billing\nis enabled. The value of this attribute cannot be changed. Possible values are : true, false
Supported operators :\nis
\nExample →\nmetered[is] = "true"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "true", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "usage_calculation", "in" : "query", "description" : "optional, enumerated string filter
\nHow the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is metered.\nThis value overrides the one set at the site level.\nPossible values are : sum_of_usages, last_usage, max_usage.
Supported operators :\nis, is_not, in, not_in
\nExample →\nusage_calculation[is_not] = "SUM_OF_USAGES"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "SUM_OF_USAGES", "properties" : { "is" : { "type" : "string", "description" : "* `sum_of_usages` - the net quantity is the sum of thequantity of all usages for the current term.\n* `last_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the most recent usage_date is taken as the net quantity consumed.\n* `max_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the maximum value is taken as the net quantity consumed.",
"enum" : [ "sum_of_usages", "last_usage", "max_usage" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `sum_of_usages` - the net quantity is the sum of the quantity of all usages for the current term.\n* `last_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the most recent usage_date is taken as the net quantity consumed.\n* `max_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the maximum value is taken as the net quantity consumed.",
"enum" : [ "sum_of_usages", "last_usage", "max_usage" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `sum_of_usages` - the net quantity is the sum of the quantity of all usages for the current term.\n* `last_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the most recent usage_date is taken as the net quantity consumed.\n* `max_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the maximum value is taken as the net quantity consumed.",
"enum" : [ "sum_of_usages", "last_usage", "max_usage" ],
"pattern" : "^\\[(sum_of_usages|last_usage|max_usage)(,(sum_of_usages|last_usage|max_usage))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `sum_of_usages` - the net quantity is the sum of the quantity of all usages for the current term.\n* `last_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the most recent usage_date is taken as the net quantity consumed.\n* `max_usage` - from among the usage records for the item price with usage_date within the relevant billing period, the quantity of the usage record with the maximum value is taken as the net quantity consumed.",
"enum" : [ "sum_of_usages", "last_usage", "max_usage" ],
"pattern" : "^\\[(sum_of_usages|last_usage|max_usage)(,(sum_of_usages|last_usage|max_usage))*\\]$",
"example" : null
}
}
}
}, {
"name" : "channel",
"in" : "query",
"description" : "optional, enumerated string filter\n\nThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*channel\\[is\\] = \"APP STORE\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "APP STORE",
"properties" : {
"is" : {
"type" : "string",
"description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n",
"enum" : [ "web", "app_store", "play_store" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n",
"enum" : [ "web", "app_store", "play_store" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n",
"enum" : [ "web", "app_store", "play_store" ],
"pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n",
"enum" : [ "web", "app_store", "play_store" ],
"pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$",
"example" : null
}
}
}
}, {
"name" : "business_entity_id",
"in" : "query",
"description" : "optional, string filter
\nThe unique ID of the\nbusiness entity\nof this item.\nLearn more\nabout all the scenarios before using this filter.
Supported operators :\nis, is_present
\nExample →\nbusiness_entity_id[is_present] = "true"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "include_site_level_resources", "in" : "query", "description" : "optional, boolean filter
\nDefault value is true . To exclude site-level resources in specific cases, set this parameter to false.\nPossible values are : true, false
Supported operators :\nis
\nExample →\ninclude_site_level_resources[is] = "null"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\nname, id, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"name\"*\n\nThis will sort the result based on the 'name' attribute in ascending(earliest first) order.\n", "required" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "asc" : { "type" : "string", "enum" : [ "name", "id", "updated_at" ], "example" : null }, "desc" : { "type" : "string", "enum" : [ "name", "id", "updated_at" ], "example" : null } }, "example" : null } }, { "name" : "bundle_configuration", "in" : "query", "description" : "Parameters of bundle_configuration
bundle_configurations.type appears when you create a bundle plan that cannot be updated during checkout or subscription creation.",
"enum" : [ "fixed" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `fixed` - Fixed bundle_configurations.type appears when you create a bundle plan that cannot be updated during checkout or subscription creation.",
"enum" : [ "fixed" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `fixed` - Fixed bundle_configurations.type appears when you create a bundle plan that cannot be updated during checkout or subscription creation.",
"enum" : [ "fixed" ],
"pattern" : "^\\[(fixed)(,(fixed))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `fixed` - Fixed bundle_configurations.type appears when you create a bundle plan that cannot be updated during checkout or subscription creation.",
"enum" : [ "fixed" ],
"pattern" : "^\\[(fixed)(,(fixed))*\\]$",
"example" : null
}
}
}
},
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"item" : {
"$ref" : "#/components/schemas/Item",
"description" : "Resource object representing item"
}
},
"required" : [ "item" ],
"example" : null
},
"example" : null
},
"next_offset" : {
"type" : "string",
"description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.",
"maxLength" : 1000,
"example" : null
}
},
"required" : [ "list" ],
"example" : null
}
}
}
},
"400" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/400"
}
}
}
},
"401" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/401"
}
}
}
},
"403" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/403"
}
}
}
},
"404" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/404"
}
}
}
},
"405" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/405"
}
}
}
},
"409" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/409"
}
}
}
},
"422" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/422"
}
}
}
},
"429" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/429"
}
}
}
},
"500" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/500"
}
}
}
},
"503" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/503"
}
}
}
}
},
"deprecated" : false,
"security" : [ {
"BasicAuth" : [ ]
} ]
},
"post" : {
"summary" : "Create an item",
"description" : "Creates a new item.\n",
"operationId" : "create_an_item",
"parameters" : [ {
"name" : "chargebee-request-origin-device",
"in" : "header",
"description" : "The device from which the customer has made the request\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-device",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "The device from which the customer has made the request\n",
"example" : "Android"
}
}, {
"name" : "chargebee-request-origin-user",
"in" : "header",
"description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-user",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"format" : "email",
"description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n",
"example" : "user@example.com"
}
}, {
"name" : "chargebee-request-origin-user-encoded",
"in" : "header",
"description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"format" : "email",
"description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n",
"example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
}
}, {
"name" : "chargebee-request-origin-ip",
"in" : "header",
"description" : "The IP address of the customer where the request originated\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-ip",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "The IP address of the customer where the request originated\n",
"example" : "192.168.1.2",
"pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
}
}, {
"name" : "chargebee-event-actions",
"in" : "header",
"description" : "skip all actions to be done on the events\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-event-actions",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "skip all actions to be done on the events\n",
"enum" : [ "all-disabled" ],
"example" : null
}
}, {
"name" : "chargebee-event-email",
"in" : "header",
"description" : "skip only emails\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-event-email",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "skip only emails\n",
"enum" : [ "all-disabled" ],
"example" : null
}
}, {
"name" : "chargebee-event-webhook",
"in" : "header",
"description" : "skip only webhooks\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-event-webhook",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "skip only webhooks\n",
"enum" : [ "all-disabled" ],
"example" : null
}
}, {
"name" : "chargebee-business-entity-id",
"in" : "header",
"description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-business-entity-id",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n",
"maxLength" : 50,
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"additionalProperties" : true,
"properties" : {
"id" : {
"type" : "string",
"deprecated" : false,
"description" : "The identifier for the item. Must be unique and is immutable once set.\n",
"maxLength" : 100,
"example" : null
},
"name" : {
"type" : "string",
"deprecated" : false,
"description" : "A unique display name for the item. Must be unique. This is visible only in Chargebee and not to customers.\n",
"maxLength" : 100,
"example" : null
},
"type" : {
"type" : "string",
"deprecated" : false,
"description" : "The type of the item.\n\\* plan -\n\nAn essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription.\n\\* charge -\n\nA non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge)\nwithout being applied to a subscription.\n\\* addon -\n\nA recurring component that can be added to a subscription in addition to its plan.\n",
"enum" : [ "plan", "addon", "charge" ],
"example" : null
},
"description" : {
"type" : "string",
"deprecated" : false,
"description" : "Description of the item. This is visible only in Chargebee and not to customers.
\nNote:
- testing - desc .\nTotal with tags: 38 characters,\ninner text: 'testing desc' (12 characters).The id\nof the Item family\nthat the item belongs to. Is mandatory when Product Families\nhave been enabled.
If enabled_for_checkout\n, then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.
Indicates which addon-items and charge-items can be applied to the item. Only possible for plan-items. Other details of attaching items such as whether to attach as a mandatory item or to attach on a certain event, can be specified using the Create\nor Update an attached item\nAPI.
\n* all -all addon-items and charge-items are applicable to this plan-item.
\n* restricted -only the addon-items or charge-items provided in applicable_items\ncan be applied to this plan-item.
The item is included in MRR calculations for your site. This attribute is only applicable for items of type = charge\nand when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude charge-items from MRR calculations, this value is always returned false\n.
Specifies whether the item undergoes metered billing. When true\n, the quantity is calculated from usage records.\nWhen false\n, the quantity\nis as determined while adding an item price to the subscription. Applicable only for items of type\nplan\nor addon\nand when Metered Billing\nis enabled. The value of this attribute cannot be changed.
How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is metered.\nThis value overrides the one set at the site level.\n.
the net quantity is the sum of the quantity\nof all usages for the current term.
from among the usage records for the item price\nwith usage_date\nwithin the relevant billing period, the quantity\nof the usage record with the most recent usage_date\nis taken as the net quantity consumed.
from among the usage records for the item price\nwith usage_date\nwithin the relevant billing period, the quantity\nof the usage record with the maximum value is taken as the net quantity consumed.
The unique ID of the business entity\nfor this item.\nThis is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the business_entity_id\nwill not be included in the API response.
Note\nAn alternative way of passing this parameter is by means of a custom HTTP header.
Parameters of bundle_configuration
Type of the bundle
\n* fixed -Fixed bundle_configuration.type\nappears when you create a bundle plan\nthat cannot be updated during checkout or subscription creation.
Parameters for bundle_items_to_add
item_id\nthat needs to be added to the bundle.\nNote:\nThis parameter is only applicable when the item_type\nis plan\n.
item_type\nthat can be added to the bundle.
A non-recurring component that can be added to a bundle plan.
\n* addon -A recurring component that can be added to a bundle plan.
\n* plan -An essential component of the bundle plan.\nNote:\nAt least one plan\nitem must be associated with the bundle.
Resource object representing item
" } }, "required" : [ "item" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/items/{item-id}/delete" : { "post" : { "summary" : "Delete an item", "description" : "Deletes an item, marking its status\nas deleted. This is not allowed if there are active\nor archived\nitem prices under the item. Once deleted, the id and name of the item can be reused.
Resource object representing item
" } }, "required" : [ "item" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/items/{item-id}" : { "get" : { "summary" : "Retrieve an item", "description" : "Retrieve an item resource.\n", "operationId" : "retrieve_an_item", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "item-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/item-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "item" : { "$ref" : "#/components/schemas/Item", "description" : "Resource object representing item
" } }, "required" : [ "item" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update an item", "description" : "Updates an item with the changes specified. Unspecified item parameters are not modified.\n", "operationId" : "update_an_item", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "item-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/item-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "name" : { "type" : "string", "deprecated" : false, "description" : "The display name for the item. Must be unique. This is visible only in Chargebee and not to customers.\n", "maxLength" : 100, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "Description of the item. This is visible only in Chargebee and not to customers.
\nNote:
- testing - desc .\nTotal with tags: 38 characters,\ninner text: 'testing desc' (12 characters).The id\nof the Item family\nthat the item belongs to. Is mandatory when Product Families\nhave been enabled.
If enabled_for_checkout\n, then the URL to be redirected to once the checkout is complete. This parameter is only meant for plan-items.
Indicates which addon-items and charge-items can be applied to the item. Only possible for plan-items. Other details of attaching items such as whether to attach as a mandatory item or to attach on a certain event, can be specified using the Create\nor Update an attached item\nAPI.
\n* all -all addon-items and charge-items are applicable to this plan-item.
\n* restricted -only the addon-items or charge-items provided in applicable_items\ncan be applied to this plan-item.
The item is included in MRR calculations for your site. This attribute is only applicable for items of type = charge\nand when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude charge-items from MRR calculations, this value is always returned false\n.
The status of the item.
\n* active -The item can be used to create new item prices.
\n* deleted -Indicates that the item has been deleted.\nThe id\nand name\ncan be reused. Deleted items can be retrieved using List items\n.
The item is no longer active and no new item prices can be created
", "enum" : [ "active", "archived" ], "example" : null }, "is_percentage_pricing" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "bundle_configuration" : { "type" : "object", "deprecated" : false, "description" : "Parameters of bundle_configuration
Type of the bundle
\n* fixed -Fixed bundle_configuration.type\nshould be provided when you create a bundle plan that cannot be updated during checkout or subscription creation.
Parameters for bundle_items_to_add
item_id\nthat needs to be added to the bundle.\nNote:\nThis parameter is only applicable when the item_type\nis plan\n.
item_type\nthat can be added to the bundle.
A non-recurring component that can be added to a bundle plan.
\n* addon -A recurring component that can be added to a bundle plan.
\n* plan -An essential component of the bundle plan.\nNote:\nAt least one plan item must be associated with the bundle.
", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "example" : null }, "quantity" : { "type" : "array", "description" : "Quantity of the item(plan, addon, and charge) associated with the bundle.\n", "items" : { "type" : "integer", "format" : "int32", "default" : 1, "deprecated" : false, "minimum" : 1, "example" : null }, "example" : null }, "price_allocation" : { "type" : "array", "description" : "Price allocation of the item(plan, addon, and charge) associated with the bundle.\n", "items" : { "type" : "number", "format" : "decimal", "deprecated" : false, "maximum" : 100, "minimum" : 0, "example" : null }, "example" : null } }, "example" : null }, "bundle_items_to_update" : { "type" : "object", "deprecated" : false, "description" : "Parameters for bundle_items_to_update\n", "properties" : { "item_id" : { "type" : "array", "description" : "item_id\nthat needs to be updated from the bundle plan. This attribute is only applicable when the item_type\nis plan\n.
item_type\nthat you want to update from the bundle.
A non-recurring component that can be added to a bundle plan.
\n* addon -A recurring component that can be added to a bundle plan.
\n* plan -An essential component of the bundle plan.\nNote:\nAt least one plan item must be associated with the bundle.
", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "example" : null }, "quantity" : { "type" : "array", "description" : "Quantity of the item(plan, addon, and charge) associated with the bundle.\n", "items" : { "type" : "integer", "format" : "int32", "default" : 1, "deprecated" : false, "minimum" : 1, "example" : null }, "example" : null }, "price_allocation" : { "type" : "array", "description" : "Price allocation of the item(plan, addon, and charge) associated with the bundle.\n", "items" : { "type" : "number", "format" : "decimal", "deprecated" : false, "maximum" : 100, "minimum" : 0, "example" : null }, "example" : null } }, "example" : null }, "bundle_items_to_remove" : { "type" : "object", "deprecated" : false, "description" : "Parameters for bundle_items_to_remove\n", "properties" : { "item_id" : { "type" : "array", "description" : "item_id\nthat needs to be removed from the bundle plan.\nNote:\nThis attribute is only applicable when the item_type\nis plan\n.
item_type\nthat you want to remove from the bundle.
A non-recurring component that can be added to a bundle plan.
\n* plan -An essential component of the bundle plan.\nNote:\nAt least one plan item must be associated with the bundle.
\n* addon -A recurring component that can be added to a bundle plan.
", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "example" : null } }, "example" : null } }, "example" : null }, "encoding" : { "bundle_configuration" : { "style" : "deepObject", "explode" : true }, "bundle_items_to_add" : { "style" : "deepObject", "explode" : true }, "bundle_items_to_remove" : { "style" : "deepObject", "explode" : true }, "bundle_items_to_update" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "item" : { "$ref" : "#/components/schemas/Item", "description" : "Resource object representing item
" } }, "required" : [ "item" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/price_variants/{price-variant-id}/delete" : { "post" : { "summary" : "Delete a price variant", "description" : "Deletes the price variant. This is not allowed if price variant is attached to any item price. Once deleted, the id and name of the price variant can be reused.
Resource object representing price_variant
" } }, "required" : [ "price_variant" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/price_variants" : { "get" : { "summary" : "List price variants", "description" : "This endpoint is used to retrieve a list of price variants.\n", "operationId" : "list_price_variants", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, string filter
\nFilter variant based on their name\ns.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nname[is] = "basic"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "status", "in" : "query", "description" : "optional, enumerated string filter
\nFilter variant based on their status.\nPossible values are : active, archived.
Supported operators :\nis, is_not, in, not_in
\nExample →\nstatus[is] = "active"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "active", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`active\\` - Active \\* \\`archived\\` - Archived\n", "enum" : [ "active", "archived" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`active\\` - Active \\* \\`archived\\` - Archived\n", "enum" : [ "active", "archived" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`active\\` - Active \\* \\`archived\\` - Archived\n", "enum" : [ "active", "archived" ], "pattern" : "^\\[(active|archived)(,(active|archived))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`active\\` - Active \\* \\`archived\\` - Archived\n", "enum" : [ "active", "archived" ], "pattern" : "^\\[(active|archived)(,(active|archived))*\\]$", "example" : null } } } }, { "name" : "updated_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\nFilter product based on their updated time\n.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[on] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "created_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\nFilter product based on their created time\n.\nSupported operators :\nafter, before, on, between
Example →\ncreated_at[before] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "business_entity_id", "in" : "query", "description" : "optional, string filter
\nThe unique ID of the\nbusiness entity\nof this price_variant.\nLearn more\nabout all the scenarios before using this filter.
Supported operators :\nis, is_present
\nExample →\nbusiness_entity_id[is_present] = "true"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "include_site_level_resources", "in" : "query", "description" : "optional, boolean filter
\nDefault value is true . To exclude site-level resources in specific cases, set this parameter to false.\nPossible values are : true, false
Supported operators :\nis
\nExample →\ninclude_site_level_resources[is] = "null"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\nname, id, status, created_at, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"name\"*\n\nThis will sort the result based on the 'name' attribute in ascending(earliest first) order.\n", "required" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "asc" : { "type" : "string", "enum" : [ "name", "id", "status", "created_at", "updated_at" ], "example" : null }, "desc" : { "type" : "string", "enum" : [ "name", "id", "status", "created_at", "updated_at" ], "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "price_variant" : { "$ref" : "#/components/schemas/PriceVariant", "description" : "Resource object representing price_variant" } }, "required" : [ "price_variant" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Create a price variant", "description" : "This endpoint allows the creation of a new price variant that can be attached to [item prices](/docs/api/item_prices).\n", "operationId" : "create_a_price_variant", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "The unique and immutable identifier of the price variant.\n", "maxLength" : 100, "example" : null }, "name" : { "type" : "string", "deprecated" : false, "description" : "A unique name of the price variant.\n", "maxLength" : 100, "example" : null }, "external_name" : { "type" : "string", "deprecated" : false, "description" : "A unique display name for the price variant.\n", "maxLength" : 100, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "Description of the price variant.\n", "maxLength" : 500, "example" : null }, "variant_group" : { "type" : "string", "deprecated" : false, "description" : "The variant_group\norganizes similar price_variants\nto optimize strategies such as bundling, geo-based pricing experiments, and campaign-specific pricing like cb-atomic-pricing-\nfor effective grouping. The variant_group\nprovides greater flexibility and precision in your pricing models.
The unique ID of the business entity\nfor this price_variant.\nThis is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the business_entity_id\nwill not be included in the API response.
Note\nAn alternative way of passing this parameter is by means of a custom HTTP header.
Resource object representing price_variant
" } }, "required" : [ "price_variant" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/price_variants/{price-variant-id}" : { "get" : { "summary" : "Retrieve a price variant", "description" : "This endpoint retrieves the details of a specific price variant using its unique identifier.\n", "operationId" : "retrieve_a_price_variant", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "price-variant-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/price-variant-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "price_variant" : { "$ref" : "#/components/schemas/PriceVariant", "description" : "Resource object representing price_variant
" } }, "required" : [ "price_variant" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a price variant", "description" : "This endpoint modifies the details of an existing price variant.\n", "operationId" : "update_a_price_variant", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "price-variant-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/price-variant-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "string", "deprecated" : false, "description" : "A unique name of the price variant.\n", "maxLength" : 100, "example" : null }, "external_name" : { "type" : "string", "deprecated" : false, "description" : "A unique display name for the price variant.\n", "maxLength" : 100, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "Description of the price variant.\n", "maxLength" : 500, "example" : null }, "variant_group" : { "type" : "string", "deprecated" : false, "description" : "The variant_group\norganizes similar price_variants\nto optimize strategies such as bundling, geo-based pricing experiments, and campaign-specific pricing like cb-atomic-pricing-\nfor effective grouping. The variant_group\nprovides greater flexibility and precision in your pricing models.
Status of a price variant.
\n* active -Active price variant. This price variant can be attached to item prices\n.
\n* deleted -Deleted price variant. The id\nand name\nof the deleted price variant can be reused.
Archived price variant. This price variant is no longer active\nand cannot be attached to new item prices.\nExisting item prices that already have this price variant attached will continue to remain as is.
Resource object representing price_variant
" } }, "required" : [ "price_variant" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/item_prices/{item-price-id}" : { "get" : { "summary" : "Retrieve an item price", "description" : "This API retrieves a specific item price using the id.\n", "operationId" : "retrieve_an_item_price", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "item-price-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/item-price-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "item_price" : { "$ref" : "#/components/schemas/ItemPrice", "description" : "Resource object representing item_price
" } }, "required" : [ "item_price" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update an item price", "description" : "Updates an item price with the changes specified. Unspecified item price attributes are not modified.\n", "operationId" : "update_an_item_price", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "item-price-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/item-price-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "name" : { "type" : "string", "deprecated" : false, "description" : "A unique display name for the item price in the Chargebee UI. If external_name\nis not provided, this is also used in customer-facing pages and documents such as invoices\nand hosted pages\n.
Description of the item price.
\nNote:
- testing - desc .\nTotal with tags: 38 characters,\ninner text: 'testing desc' (12 characters).Note\nApplicable only for item prices with:
item_type = addon.pricing_model = per_unit.Specifies how to manage charges or credits for the addon item price during a subscription update\nor estimating\na subscription update.
\n* full_term -Charge the full price of the addon item price or give the full credit. Don't apply any proration.
\n* site_default -Use the site-wide proration setting\n.
\n* partial_term -Prorate the charges or credits for the rest of the current term.
", "enum" : [ "site_default", "partial_term", "full_term" ], "example" : null }, "price_variant_id" : { "type" : "string", "deprecated" : false, "description" : "An immutable unique identifier of a [price variant](/docs/api/price_variants).\n", "maxLength" : 100, "example" : null }, "status" : { "type" : "string", "deprecated" : false, "description" : "The status of the item price.
\n* archived -The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.
\n* active -The item price can be used in subscriptions.
\n* deleted -Indicates that the item price has been deleted. The id\nand name\ncan be reused.
The name of the item price used in customer-facing pages and documents. These include invoices\nand hosted pages.\nIf not provided, then name\nis used.
Specifies the frequency at which the usage counter needs to be reset.
\nNote:\nChanges to the usage_accumulation_reset_frequency\nparameter for item_price\nis not allowed if the item\nis already linked to a subscription.
.
\n* never -Accumulates usage without ever resetting it.
\n* subscription_billing_frequency -Accumulates usage until the subscription's billing frequency ends.
", "enum" : [ "never", "subscription_billing_frequency" ], "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "The currency code (ISO 4217 format\n) for the item price. If subscriptions, invoices or differential prices\nexist for this item price, currency_code\ncannot be changed.
Free quantity the subscriptions of this plan item_price will have. Only the quantity exceeding this value will be charged in the subscription.
Note:
free_quantity is currently supported only for plan item_price.free_quantity\nis not supported for the Usage-Based Billing\n(UBB). All included or free quantities should be configured exclusively through entitlements\n.The pricing scheme for this item price. If subscriptions, invoices or differential prices exist for this item price, pricing_model cannot be changed.
There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
\n* per_unit -A fixed price per unit quantity.
\n* flat_fee -A fixed price that is not quantity-based.
\n* volume -The per unit price is based on the tier that the total quantity falls in.
\n* stairstep -A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
", "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ], "example" : null }, "price" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The cost of the item price when the pricing model is flat_fee.\nWhen the pricing model is per_unit\n, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the minor unit of the currency\n.
The price of the item when the pricing_model is flat_fee.\nWhen the pricing model is per_unit\n, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when multi-decimal pricing\nis enabled.
The unit of time for period.\nIf subscriptions or invoices exist for this item price, period_unit\ncannot be changed. The period_unit\nis mandatory when the item type\nis plan\nor addon\n.
Important:\nThe period + period_unit pair must match a configured billing frequency on your site. The API does not create new frequencies. To use a new frequency (for example, 3 months or 2 weeks), add it in the site settings first. Requests with non-configured combinations fail validation.
period=1, period_unit=month (available by default)period=3, period_unit=month (enable 3-month frequency in settings)period=1, period_unit=week (available by default)\nSee how billing periods apply\n.A period of 1 calendar month.
\n* week -A period of 7 days.
\n* year -A period of 1 calendar year.
\n* day -A period of 24 hours.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "type is plan: The billing period of the plan in period_units. For example, create a 6 month plan by providing period as 6 and period_unit as month.type is addon: The period of the addon in period_units. For example, create an addon with a 2 month period by providing period as 2 and period_unit as month. The period of an addon is the duration for which its price applies. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.If subscriptions or invoices exist for this item price, period\ncannot be changed. The period\nis mandatory when the item type\nis plan\nor addon.
Important:\nThe period value, together with period_unit, must equal one of your site's configured billing frequencies. If the combination does not exist, the request fails with an invalid billing period configuration error. Configure the frequency in site settings and retry. See Addons and billing cycle.
The unit of time for trial_period\n.
A period of 1 calendar month.
\n* day -A period of 24 hours.
", "enum" : [ "day", "month" ], "example" : null }, "trial_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The trial period of the plan in trial_period_unit\ns. You can also set trial periods for addons\n; contact Support\nto enable that feature.
The default number of billing cycles a subscription to the plan must run. Can be overridden for a subscription.\nAddons can also have billing cycles. Also, for addons, you can override this while attaching it to a plan. However, if you provide the value while applying the addon to a subscription, then that value takes still higher precedence.\nIf subscriptions, invoices or differential prices\nexist for this item price, billing_cycles\ncannot be changed.
Note:\nIf you want to change the billing_cycles\nto unlimited renewals, enter an empty string. This value can only be updated if the item_price\nis not attached to a subscription or invoice. If no billing_cycles\nvalue is entered, then by default the value will be set as unlimited billing_cycles\nrenewals.
Applicable only when End-of-trial Action\nhas been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the item.type\nis plan\nand a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the subscription-level\n.
The subscription cancels.
\n* activate_subscription -The subscription activates and charges are raised for non-metered items.
\n* site_default -The action configured for the site\nat the time when the trial ends, takes effect.
", "enum" : [ "site_default", "activate_subscription", "cancel_subscription" ], "example" : null }, "show_description_in_invoices" : { "type" : "boolean", "deprecated" : false, "description" : "Whether the item price's description should be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf).\nIf this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/invoice-operations.html#actions-for-payment-due-not-paid-invoices_regenerate-invoice)\n) after the change are affected; past invoices are not.\n", "example" : null }, "show_description_in_quotes" : { "type" : "boolean", "deprecated" : false, "description" : "Whether the item price's description should be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).\nIf this Boolean is changed, only quotes created after the change are affected; past quotes are not.\n", "example" : null }, "tax_detail" : { "type" : "object", "deprecated" : false, "description" : "Parameters for tax_detail\n", "properties" : { "tax_profile_id" : { "type" : "string", "deprecated" : false, "description" : "The tax profile of the item price.\n", "maxLength" : 50, "example" : null }, "avalara_tax_code" : { "type" : "string", "deprecated" : false, "description" : "The [Avalara tax codes](https://taxcode.avatax.avalara.com)\nfor the item price. Applicable only if you use [AvaTax for Sales integration](https://www.chargebee.com/docs/2.0/avatax-for-sales.html)\n.\n", "maxLength" : 50, "example" : null }, "hsn_code" : { "type" : "string", "deprecated" : false, "description" : "The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.\n", "maxLength" : 50, "example" : null }, "avalara_sale_type" : { "type" : "string", "deprecated" : false, "description" : "Indicates the [Avalara sale type](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/transaction-information/#lineitem)\nfor the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)\n.\n\\* vendor_use -\n\nTransaction is for an item that is subject to vendor use tax\n\\* consumed -\n\nTransaction is for an item that is consumed directly\n\\* wholesale -\n\nTransaction is a sale to another company that will resell your product or service to another consumer\n\\* retail -\n\nTransaction is a sale to an end user\n", "enum" : [ "wholesale", "retail", "consumed", "vendor_use" ], "example" : null }, "avalara_transaction_type" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Indicates the [Avalara transaction type](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/transaction-information/#lineitem)\nfor the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)\n.\n", "example" : null }, "avalara_service_type" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Indicates the [Avalara service type](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/transaction-information/#lineitem)\nfor the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)\n.\n", "example" : null }, "taxjar_product_code" : { "type" : "string", "deprecated" : false, "description" : "The [TaxJar product code](https://developers.taxjar.com/api/reference/#get-list-tax-categories)\nfor the item price. Applicable only if you use [TaxJar integration](https://www.chargebee.com/docs/2.0/taxjar.html)\n.\n", "maxLength" : 50, "example" : null } }, "example" : null }, "accounting_detail" : { "type" : "object", "deprecated" : false, "description" : "Parameters for accounting_detail\n", "properties" : { "sku" : { "type" : "string", "deprecated" : false, "description" : "This maps to the sku or product name in the accounting integration.\n", "maxLength" : 100, "example" : null }, "accounting_code" : { "type" : "string", "deprecated" : false, "description" : "The identifier of the chart of accounts under which the item price falls in the accounting system.\n", "maxLength" : 100, "example" : null }, "accounting_category1" : { "type" : "string", "deprecated" : false, "description" : "Used exclusively with the following accounting integrations
\n: . For example:Location: Singapore.::...: : .... For example: Services: Plan.Used exclusively with the following accounting integrations
\n: .... For example, Region: South::.... For example: Location: North America: Canada: : .... For example: NA:US:CAUsed exclusively with the following accounting integrations
\n: : .... For example: Production: Assembly.The per-unit price for the tier when the pricing_model\nis tiered\nor volume\n; the total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency\n.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the addon. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20, consuming 400 units will result in a charge of $80 (4 × $20).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing item_price
" } }, "required" : [ "item_price" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/item_prices/{item-price-id}/delete" : { "post" : { "summary" : "Delete an item price", "description" : "Deletes an item price, marking its status as deleted. If it is part of a subscription or invoice, the item price status is marked archived instead. Once deleted, the id and name of the item price can be reused to create a new item price.
Resource object representing item_price
" } }, "required" : [ "item_price" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/item_prices/{item-price-id}/applicable_item_prices" : { "get" : { "summary" : "List applicable item prices for a plan-item price", "description" : "Returns the set of all applicable addon-item\nprices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
item_applicability and applicable_items defined for the parent item of the plan-item priceNote
If an addon-item price has differential pricing defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Returns the set of all applicable addon-items\nfor a specific plan-item price\n. This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the item_applicability\nand applicable_items\ndefined for the parent item of the plan-item price.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, string filter
\nFilter item prices based on their name\ns.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nname[is] = "basic USD"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic USD", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "pricing_model", "in" : "query", "description" : "optional, enumerated string filter
\nFilter item prices based on their pricing_model.\nPossible values are : flat_fee, per_unit, tiered, volume, stairstep.
Supported operators :\nis, is_not, in, not_in
\nExample →\npricing_model[is] = "flat_fee"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "flat_fee", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`flat_fee\\` - A fixed price that is not quantity-based. \\* \\`per_unit\\` - A fixed price per unit quantity. \\* \\`tiered\\` - The per unit price is based on the tier that the total quantity falls in. \\* \\`volume\\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \\* \\`stairstep\\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n", "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`flat_fee\\` - A fixed price that is not quantity-based. \\* \\`per_unit\\` - A fixed price per unit quantity. \\* \\`tiered\\` - The per unit price is based on the tier that the total quantity falls in. \\* \\`volume\\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \\* \\`stairstep\\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n", "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`flat_fee\\` - A fixed price that is not quantity-based. \\* \\`per_unit\\` - A fixed price per unit quantity. \\* \\`tiered\\` - The per unit price is based on the tier that the total quantity falls in. \\* \\`volume\\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \\* \\`stairstep\\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n", "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ], "pattern" : "^\\[(flat_fee|per_unit|tiered|volume|stairstep)(,(flat_fee|per_unit|tiered|volume|stairstep))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`flat_fee\\` - A fixed price that is not quantity-based. \\* \\`per_unit\\` - A fixed price per unit quantity. \\* \\`tiered\\` - The per unit price is based on the tier that the total quantity falls in. \\* \\`volume\\` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \\* \\`stairstep\\` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n", "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ], "pattern" : "^\\[(flat_fee|per_unit|tiered|volume|stairstep)(,(flat_fee|per_unit|tiered|volume|stairstep))*\\]$", "example" : null } } } }, { "name" : "item_id", "in" : "query", "description" : "optional, string filter
\nFilter item prices based on their item_id\n.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nitem_id[is] = "basic"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "item_family_id", "in" : "query", "description" : "optional, string filter
\nFilter item prices based on item_family_id\n.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nitem_family_id[is] = "Acme"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "Acme", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "item_type", "in" : "query", "description" : "optional, enumerated string filter
\nFilter item prices based on item_type.\nPossible values are : plan, addon, charge.
Supported operators :\nis, is_not, in, not_in
\nExample →\nitem_type[is_not] = "plan"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "plan", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "pattern" : "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "pattern" : "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$", "example" : null } } } }, { "name" : "currency_code", "in" : "query", "description" : "optional, string filter
\nFilter item prices based on their currency_code\n.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\ncurrency_code[is_not] = "USD"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "USD", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "price_variant_id", "in" : "query", "description" : "optional, string filter
\nFilter item prices based on their price_variant_id\n.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nprice_variant_id[is] = "tamilNadu-India"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "tamilNadu-India", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "trial_period", "in" : "query", "description" : "optional, integer filter
\nFilter item prices based on their trial_period\n.\nSupported operators :\nis, is_not, lt, lte, gt, gte, between
Example →\ntrial_period[is] = "14"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "14", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } } }, { "name" : "trial_period_unit", "in" : "query", "description" : "optional, enumerated string filter
\nFilter item prices based on their trial_period_unit.\nPossible values are : day, month.
Supported operators :\nis, is_not, in, not_in
\nExample →\ntrial_period_unit[is] = "day"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "day", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`day\\` - A period of 24 hours. \\* \\`month\\` - A period of 1 calendar month.\n", "enum" : [ "day", "month" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`day\\` - A period of 24 hours. \\* \\`month\\` - A period of 1 calendar month.\n", "enum" : [ "day", "month" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`day\\` - A period of 24 hours. \\* \\`month\\` - A period of 1 calendar month.\n", "enum" : [ "day", "month" ], "pattern" : "^\\[(day|month)(,(day|month))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`day\\` - A period of 24 hours. \\* \\`month\\` - A period of 1 calendar month.\n", "enum" : [ "day", "month" ], "pattern" : "^\\[(day|month)(,(day|month))*\\]$", "example" : null } } } }, { "name" : "status", "in" : "query", "description" : "optional, enumerated string filter
\nFilter item prices based on their status.\nPossible values are : active, archived.
Supported operators :\nis, is_not, in, not_in
\nExample →\nstatus[is] = "active"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "active", "properties" : { "is" : { "type" : "string", "description" : "* `active` - The item price can be used in subscriptions.\n* `archived` - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.\n* `deleted` - Indicates that the item price has been deleted. Theid and name can be reused.",
"enum" : [ "active", "archived", "deleted" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `active` - The item price can be used in subscriptions.\n* `archived` - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.\n* `deleted` - Indicates that the item price has been deleted. The id and name can be reused.",
"enum" : [ "active", "archived", "deleted" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `active` - The item price can be used in subscriptions.\n* `archived` - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.\n* `deleted` - Indicates that the item price has been deleted. The id and name can be reused.",
"enum" : [ "active", "archived", "deleted" ],
"pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `active` - The item price can be used in subscriptions.\n* `archived` - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.\n* `deleted` - Indicates that the item price has been deleted. The id and name can be reused.",
"enum" : [ "active", "archived", "deleted" ],
"pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
"example" : null
}
}
}
}, {
"name" : "updated_at",
"in" : "query",
"description" : "optional, timestamp(UTC) in seconds filter
\nFilter item prices based on their updated_at\n.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[after] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "business_entity_id", "in" : "query", "description" : "optional, string filter
\nThe unique ID of the\nbusiness entity\nof this item_price.\nLearn more\nabout all the scenarios before using this filter.
Supported operators :\nis, is_present
\nExample →\nbusiness_entity_id[is_present] = "true"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "include_site_level_resources", "in" : "query", "description" : "optional, boolean filter
\nDefault value is true . To exclude site-level resources in specific cases, set this parameter to false.\nPossible values are : true, false
Supported operators :\nis
\nExample →\ninclude_site_level_resources[is] = "null"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null } }, { "name" : "period_unit", "in" : "query", "description" : "optional, enumerated string filter
\nFilter item prices based on their period_unit.\nPossible values are : day, week, month, year.
Supported operators :\nis, is_not, in, not_in
\nExample →\nperiod_unit[is] = "month"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "month", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`day\\` - A period of 24 hours. \\* \\`week\\` - A period of 7 days. \\* \\`month\\` - A period of 1 calendar month. \\* \\`year\\` - A period of 1 calendar year.\n", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`day\\` - A period of 24 hours. \\* \\`week\\` - A period of 7 days. \\* \\`month\\` - A period of 1 calendar month. \\* \\`year\\` - A period of 1 calendar year.\n", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`day\\` - A period of 24 hours. \\* \\`week\\` - A period of 7 days. \\* \\`month\\` - A period of 1 calendar month. \\* \\`year\\` - A period of 1 calendar year.\n", "enum" : [ "day", "week", "month", "year" ], "pattern" : "^\\[(day|week|month|year)(,(day|week|month|year))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`day\\` - A period of 24 hours. \\* \\`week\\` - A period of 7 days. \\* \\`month\\` - A period of 1 calendar month. \\* \\`year\\` - A period of 1 calendar year.\n", "enum" : [ "day", "week", "month", "year" ], "pattern" : "^\\[(day|week|month|year)(,(day|week|month|year))*\\]$", "example" : null } } } }, { "name" : "period", "in" : "query", "description" : "optional, integer filter
\nFilter item prices based on their period\n.\nSupported operators :\nis, is_not, lt, lte, gt, gte, between
Example →\nperiod[is] = "3"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "3", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } } }, { "name" : "channel", "in" : "query", "description" : "optional, enumerated string filter\n\nThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*channel\\[is\\] = \"APP STORE\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "APP STORE", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null } } } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\nname, id, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"name\"*\n\nThis will sort the result based on the 'name' attribute in ascending(earliest first) order.\n", "required" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "asc" : { "type" : "string", "enum" : [ "name", "id", "updated_at" ], "example" : null }, "desc" : { "type" : "string", "enum" : [ "name", "id", "updated_at" ], "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "item_price" : { "$ref" : "#/components/schemas/ItemPrice", "description" : "Resource object representing item_price" } }, "required" : [ "item_price" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Create an item price", "description" : "This API creates an item price (a price point) for an [item](/docs/api/items).\n", "operationId" : "create_an_item_price", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "The identifier for the item price. It is unique and immutable.\n", "maxLength" : 100, "example" : null }, "name" : { "type" : "string", "deprecated" : false, "description" : "A unique display name for the item price in the Chargebee UI. If external_name\nis not provided, this is also used in customer-facing pages and documents such as invoices\nand hosted pages\n.
Description of the item price.
\nNote:
- testing - desc .\nTotal with tags: 38 characters,\ninner text: 'testing desc' (12 characters).Note\nApplicable only for item prices with:
item_type = addon.pricing_model = per_unit.Specifies how to manage charges or credits for the addon item price during a subscription update\nor estimating\na subscription update.
\n* full_term -Charge the full price of the addon item price or give the full credit. Don't apply any proration.
\n* site_default -Use the site-wide proration setting\n.
\n* partial_term -Prorate the charges or credits for the rest of the current term.
", "enum" : [ "site_default", "partial_term", "full_term" ], "example" : null }, "external_name" : { "type" : "string", "deprecated" : false, "description" : "The name of the item price used in customer-facing pages and documents. These include invoices\nand hosted pages.\nIf not provided, then name\nis used.
Free quantity the subscriptions of this plan item_price will have. Only the quantity exceeding this value will be charged in the subscription.
Note:
free_quantity is currently supported only for plan item_price.free_quantity\nis not supported for the Usage-Based Billing\n(UBB). All included or free quantities should be configured exclusively through entitlements\n.Specifies the frequency at which the usage counter needs to be reset.
\nNote:\nChanges to the usage_accumulation_reset_frequency\nparameter for item_price\nis not allowed if the item\nis already linked to a subscription.
.
\n* never -Accumulates usage without ever resetting it.
\n* subscription_billing_frequency -Accumulates usage until the subscription's billing frequency ends.
", "enum" : [ "never", "subscription_billing_frequency" ], "example" : null }, "business_entity_id" : { "type" : "string", "deprecated" : false, "description" : "The unique ID of the business entity\nfor this item_price.\nThis is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the business_entity_id\nwill not be included in the API response.
Note\nAn alternative way of passing this parameter is by means of a custom HTTP header.
The pricing scheme for this item price. If subscriptions, invoices or differential prices exist for this item price, pricing_model cannot be changed.
There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
\n* per_unit -A fixed price per unit quantity.
\n* flat_fee -A fixed price that is not quantity-based.
\n* volume -The per unit price is based on the tier that the total quantity falls in.
\n* stairstep -A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
", "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ], "example" : null }, "price" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The cost of the item price when the pricing model is flat_fee.\nWhen the pricing model is per_unit\n, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the minor unit of the currency\n.
The price of the item when the pricing_model is flat_fee.\nWhen the pricing model is per_unit\n, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when multi-decimal pricing\nis enabled.
The unit of time for period.\nIf subscriptions or invoices exist for this item price, period_unit\ncannot be changed. The period_unit\nis mandatory when the item type\nis plan\nor addon\n.
Important:\nThe period + period_unit pair must match a configured billing frequency on your site. The API does not create new frequencies. To use a new frequency (for example, 3 months or 2 weeks), add it in the site settings first. Requests with non-configured combinations fail validation.
period=1, period_unit=month (available by default)period=3, period_unit=month (enable 3-month frequency in settings)period=1, period_unit=week (available by default)\nSee how billing periods apply\n.A period of 1 calendar month.
\n* week -A period of 7 days.
\n* year -A period of 1 calendar year.
\n* day -A period of 24 hours.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "type is plan: The billing period of the plan in period_units. For example, create a 6 month plan by providing period as 6 and period_unit as month.type is addon: The period of the addon in period_units. For example, create an addon with a 2 month period by providing period as 2 and period_unit as month. The period of an addon is the duration for which its price applies. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.If subscriptions or invoices exist for this item price, period\ncannot be changed. The period\nis mandatory when the item type\nis plan\nor addon.
Important:\nThe period value, together with period_unit, must equal one of your site's configured billing frequencies. If the combination does not exist, the request fails with an invalid billing period configuration error. Configure the frequency in site settings and retry. See Addons and billing cycle.
The unit of time for trial_period\n.
A period of 1 calendar month.
\n* day -A period of 24 hours.
", "enum" : [ "day", "month" ], "example" : null }, "trial_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The trial period of the plan in trial_period_unit\ns. You can also set trial periods for addons\n; contact Support\nto enable that feature.
The default number of billing cycles a subscription to the plan must run. Can be overridden for a subscription.\nAddons can also have billing cycles. Also, for addons, you can override this while attaching it to a plan. However, if you provide the value while applying the addon to a subscription, then that value takes still higher precedence.\nIf subscriptions, invoices or differential prices\nexist for this item price, billing_cycles\ncannot be changed.
Note:\nIf you want to change the billing_cycles\nto unlimited renewals, enter an empty string. This value can only be updated if the item_price\nis not attached to a subscription or invoice. If no billing_cycles\nvalue is entered, then by default the value will be set as unlimited billing_cycles\nrenewals.
Applicable only when End-of-trial Action\nhas been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the item.type\nis plan\nand a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the subscription-level\n.
The subscription cancels.
\n* activate_subscription -The subscription activates and charges are raised for non-metered items.
\n* site_default -The action configured for the site\nat the time when the trial ends, takes effect.
", "enum" : [ "site_default", "activate_subscription", "cancel_subscription" ], "example" : null }, "tax_detail" : { "type" : "object", "deprecated" : false, "description" : "Parameters for tax_detail\n", "properties" : { "tax_profile_id" : { "type" : "string", "deprecated" : false, "description" : "The tax profile of the item price.\n", "maxLength" : 50, "example" : null }, "avalara_tax_code" : { "type" : "string", "deprecated" : false, "description" : "The [Avalara tax codes](https://taxcode.avatax.avalara.com)\nfor the item price. Applicable only if you use [AvaTax for Sales integration](https://www.chargebee.com/docs/2.0/avatax-for-sales.html)\n.\n", "maxLength" : 50, "example" : null }, "hsn_code" : { "type" : "string", "deprecated" : false, "description" : "The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.\n", "maxLength" : 50, "example" : null }, "avalara_sale_type" : { "type" : "string", "deprecated" : false, "description" : "Indicates the [Avalara sale type](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/transaction-information/#lineitem)\nfor the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)\n.\n\\* vendor_use -\n\nTransaction is for an item that is subject to vendor use tax\n\\* consumed -\n\nTransaction is for an item that is consumed directly\n\\* wholesale -\n\nTransaction is a sale to another company that will resell your product or service to another consumer\n\\* retail -\n\nTransaction is a sale to an end user\n", "enum" : [ "wholesale", "retail", "consumed", "vendor_use" ], "example" : null }, "avalara_transaction_type" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Indicates the [Avalara transaction type](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/transaction-information/#lineitem)\nfor the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)\n.\n", "example" : null }, "avalara_service_type" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Indicates the [Avalara service type](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/transaction-information/#lineitem)\nfor the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)\n.\n", "example" : null }, "taxjar_product_code" : { "type" : "string", "deprecated" : false, "description" : "The [TaxJar product code](https://developers.taxjar.com/api/reference/#get-list-tax-categories)\nfor the item price. Applicable only if you use [TaxJar integration](https://www.chargebee.com/docs/2.0/taxjar.html)\n.\n", "maxLength" : 50, "example" : null } }, "example" : null }, "accounting_detail" : { "type" : "object", "deprecated" : false, "description" : "Parameters for accounting_detail\n", "properties" : { "sku" : { "type" : "string", "deprecated" : false, "description" : "This maps to the sku or product name in the accounting integration.\n", "maxLength" : 100, "example" : null }, "accounting_code" : { "type" : "string", "deprecated" : false, "description" : "The identifier of the chart of accounts under which the item price falls in the accounting system.\n", "maxLength" : 100, "example" : null }, "accounting_category1" : { "type" : "string", "deprecated" : false, "description" : "Used exclusively with the following accounting integrations
\n: . For example:Location: Singapore.::...: : .... For example: Services: Plan.Used exclusively with the following accounting integrations
\n: .... For example, Region: South::.... For example: Location: North America: Canada: : .... For example: NA:US:CAUsed exclusively with the following accounting integrations
\n: : .... For example: Production: Assembly.The per-unit price for the tier when the pricing_model\nis tiered\nor volume\n; the total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency\n.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the addon. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20, consuming 400 units will result in a charge of $80 (4 × $20).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing item_price
" } }, "required" : [ "item_price" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/attached_items/{attached-item-id}" : { "get" : { "summary" : "Retrieve an attached item", "description" : "Retrieves details of an attached addon or a charge item.\n", "operationId" : "retrieve_an_attached_item_", "parameters" : [ { "name" : "parent_item_id", "in" : "query", "description" : "The id\nof the plan-item to which the item is attached.
Resource object representing attached_item
" } }, "required" : [ "attached_item" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update an attached item", "description" : "Updates an attached addon or a charge item for a plan.\n", "operationId" : "update_an_attached_item", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "attached-item-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/attached-item-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "parent_item_id" : { "type" : "string", "deprecated" : false, "description" : "The id of the parent item in the attachment relationship.\n", "maxLength" : 100, "example" : null }, "type" : { "type" : "string", "deprecated" : false, "description" : "The type of attachment for the addon. Only applicable for addon-items and is a required parameter as well for addon-items.
\n* recommended -The addon is recommended to go with the plan-item when using Checkout\nor Portal\n.
\n* optional -The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a quantity\nand billing_cycles\nfor the addon, for when it is applied to subscriptions with the plan.
The addon is attached automatically to the subscription for the plan-item unless explicitly removed\nvia API.
", "enum" : [ "recommended", "mandatory", "optional" ], "example" : null }, "billing_cycles" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires addon billing cycles\nto be enabled for the site.
\nThe value set explicitly for billing_cycles\nwhile applying the addon to a subscription\ntakes precedence over this parameter. This parameter, in turn, has a higher precedence than the value set for the addon-item price\n.
Indicates when the item is charged. This parameter only applies to charge-items.
\n* contract_termination -when a contract term is terminated\n.
\n* subscription_creation -the time of creation of the subscription.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* on_demand -Item can be charged on demand
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Resource object representing attached_item
" } }, "required" : [ "attached_item" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/items/{item-id}/attached_items" : { "get" : { "summary" : "List attached items", "description" : "Returns a list of attached items satisfying **all**\nthe conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).\n", "operationId" : "list_attached_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "item-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/item-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, string filter
\nFilter attached items based on the item_id\nof the item being attached.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nitem_id[is] = "basic"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "type", "in" : "query", "description" : "optional, enumerated string filter
\nFilter attached items based on the type\nof attached item. Possible values are : recommended\n, mandatory\n, optional.\nPossible values are : recommended, mandatory, optional.
Supported operators :\nis, is_not, in, not_in
\nExample →\ntype[is] = "mandatory"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "mandatory", "properties" : { "is" : { "type" : "string", "description" : "* `recommended` - The addon is recommended to go with the plan-item when using Checkout or Portal.\n* `mandatory` - The addon is attached automatically to the subscription for the plan-item unless explicitly removed via API.\n* `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify aquantity and billing_cycles for the addon, for when it is applied to subscriptions with the plan.",
"enum" : [ "recommended", "mandatory", "optional" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `recommended` - The addon is recommended to go with the plan-item when using Checkout or Portal.\n* `mandatory` - The addon is attached automatically to the subscription for the plan-item unless explicitly removed via API.\n* `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a quantity and billing_cycles for the addon, for when it is applied to subscriptions with the plan.",
"enum" : [ "recommended", "mandatory", "optional" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `recommended` - The addon is recommended to go with the plan-item when using Checkout or Portal.\n* `mandatory` - The addon is attached automatically to the subscription for the plan-item unless explicitly removed via API.\n* `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a quantity and billing_cycles for the addon, for when it is applied to subscriptions with the plan.",
"enum" : [ "recommended", "mandatory", "optional" ],
"pattern" : "^\\[(recommended|mandatory|optional)(,(recommended|mandatory|optional))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `recommended` - The addon is recommended to go with the plan-item when using Checkout or Portal.\n* `mandatory` - The addon is attached automatically to the subscription for the plan-item unless explicitly removed via API.\n* `optional` - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a quantity and billing_cycles for the addon, for when it is applied to subscriptions with the plan.",
"enum" : [ "recommended", "mandatory", "optional" ],
"pattern" : "^\\[(recommended|mandatory|optional)(,(recommended|mandatory|optional))*\\]$",
"example" : null
}
}
}
}, {
"name" : "item_type",
"in" : "query",
"description" : "optional, enumerated string filter
\nTo filter based on the type of of the attached item. Possible values are : addon\n, charge.\nPossible values are : plan, addon, charge.
Supported operators :\nis, is_not, in, not_in
\nExample →\nitem_type[is_not] = "plan"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "plan", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "pattern" : "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`plan\\` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. \\* \\`addon\\` - A recurring component that can be added to a subscription in addition to its plan. \\* \\`charge\\` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](./invoices?prod_cat_ver=2#create_invoice_for_a_charge-item) without being applied to a subscription.\n", "enum" : [ "plan", "addon", "charge" ], "pattern" : "^\\[(plan|addon|charge)(,(plan|addon|charge))*\\]$", "example" : null } } } }, { "name" : "charge_on_event", "in" : "query", "description" : "optional, enumerated string filter\n\nIndicates when the item is charged. This attribute only applies to charge-items. Possible values are : subscription_creation, subscription_trial_start, plan_activation, subscription_activation, contract_termination, on_demand.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*charge_on_event\\[is\\] = \"subscription_creation\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "subscription_creation", "properties" : { "is" : { "type" : "string", "description" : "* `subscription_creation` - the time of creation of the subscription.\n* `subscription_trial_start` - the time when the trial period of the subscription begins.\n* `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.\n* `subscription_activation` - the moment a subscription enters anactive or non-renewing state. Also includes reactivations of canceled subscriptions.\n* `contract_termination` - when a contract term is terminated.\n* `on_demand` - Item can be charged on demand",
"enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination", "on_demand" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `subscription_creation` - the time of creation of the subscription.\n* `subscription_trial_start` - the time when the trial period of the subscription begins.\n* `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.\n* `subscription_activation` - the moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.\n* `contract_termination` - when a contract term is terminated.\n* `on_demand` - Item can be charged on demand",
"enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination", "on_demand" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `subscription_creation` - the time of creation of the subscription.\n* `subscription_trial_start` - the time when the trial period of the subscription begins.\n* `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.\n* `subscription_activation` - the moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.\n* `contract_termination` - when a contract term is terminated.\n* `on_demand` - Item can be charged on demand",
"enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination", "on_demand" ],
"pattern" : "^\\[(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand)(,(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `subscription_creation` - the time of creation of the subscription.\n* `subscription_trial_start` - the time when the trial period of the subscription begins.\n* `plan_activation` - same as subscription activation, but also includes the case when the plan-item of the subscription is changed.\n* `subscription_activation` - the moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.\n* `contract_termination` - when a contract term is terminated.\n* `on_demand` - Item can be charged on demand",
"enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination", "on_demand" ],
"pattern" : "^\\[(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand)(,(subscription_creation|subscription_trial_start|plan_activation|subscription_activation|contract_termination|on_demand))*\\]$",
"example" : null
}
}
}
}, {
"name" : "updated_at",
"in" : "query",
"description" : "optional, timestamp(UTC) in seconds filter\n\nFilter attached items based on when the attached items were last updated.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[after\\] = \"1243545465\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "1243545465",
"properties" : {
"after" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"before" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"on" : {
"type" : "string",
"format" : "unix-time",
"pattern" : "^\\d{10}$",
"example" : null
},
"between" : {
"type" : "string",
"pattern" : "^\\[\\d{10},\\d{10}\\]$",
"example" : null
}
}
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"attached_item" : {
"$ref" : "#/components/schemas/AttachedItem",
"description" : "Resource object representing attached_item"
}
},
"required" : [ "attached_item" ],
"example" : null
},
"example" : null
},
"next_offset" : {
"type" : "string",
"description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.",
"maxLength" : 1000,
"example" : null
}
},
"required" : [ "list" ],
"example" : null
}
}
}
},
"400" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/400"
}
}
}
},
"401" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/401"
}
}
}
},
"403" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/403"
}
}
}
},
"404" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/404"
}
}
}
},
"405" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/405"
}
}
}
},
"409" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/409"
}
}
}
},
"422" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/422"
}
}
}
},
"429" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/429"
}
}
}
},
"500" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/500"
}
}
}
},
"503" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/503"
}
}
}
}
},
"deprecated" : false,
"security" : [ {
"BasicAuth" : [ ]
} ]
},
"post" : {
"summary" : "Create an attached item",
"description" : "Creates an attached addon or a charge item for a plan.\n",
"operationId" : "create_an_attached_item",
"parameters" : [ {
"name" : "chargebee-request-origin-device",
"in" : "header",
"description" : "The device from which the customer has made the request\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-device",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "The device from which the customer has made the request\n",
"example" : "Android"
}
}, {
"name" : "chargebee-request-origin-user",
"in" : "header",
"description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-user",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"format" : "email",
"description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n",
"example" : "user@example.com"
}
}, {
"name" : "chargebee-request-origin-user-encoded",
"in" : "header",
"description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"format" : "email",
"description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n",
"example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
}
}, {
"name" : "chargebee-request-origin-ip",
"in" : "header",
"description" : "The IP address of the customer where the request originated\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-ip",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "The IP address of the customer where the request originated\n",
"example" : "192.168.1.2",
"pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
}
}, {
"name" : "chargebee-event-actions",
"in" : "header",
"description" : "skip all actions to be done on the events\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-event-actions",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "skip all actions to be done on the events\n",
"enum" : [ "all-disabled" ],
"example" : null
}
}, {
"name" : "chargebee-event-email",
"in" : "header",
"description" : "skip only emails\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-event-email",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "skip only emails\n",
"enum" : [ "all-disabled" ],
"example" : null
}
}, {
"name" : "chargebee-event-webhook",
"in" : "header",
"description" : "skip only webhooks\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-event-webhook",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "skip only webhooks\n",
"enum" : [ "all-disabled" ],
"example" : null
}
}, {
"name" : "chargebee-business-entity-id",
"in" : "header",
"description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-business-entity-id",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n",
"maxLength" : 50,
"example" : null
}
}, {
"name" : "item-id",
"in" : "path",
"required" : true,
"deprecated" : false,
"$ref" : "#/components/parameters/item-id",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"item_id" : {
"type" : "string",
"deprecated" : false,
"description" : "The id of the addon or charge that is being attached to the plan-item.\n",
"maxLength" : 100,
"example" : null
},
"type" : {
"type" : "string",
"deprecated" : false,
"description" : "The type of attachment for the addon. Only applicable for addon-items and is a required parameter as well for addon-items.
\n* recommended -The addon is recommended to go with the plan-item when using Checkout\nor Portal\n.
\n* optional -The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a quantity\nand billing_cycles\nfor the addon, for when it is applied to subscriptions with the plan.
The addon is attached automatically to the subscription for the plan-item unless explicitly removed\nvia API.
", "enum" : [ "recommended", "mandatory", "optional" ], "example" : null }, "billing_cycles" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires addon billing cycles\nto be enabled for the site.
\nThe value set explicitly for billing_cycles\nwhile applying the addon to a subscription\ntakes precedence over this parameter. This parameter, in turn, has a higher precedence than the value set for the addon-item price\n.
Indicates when the item is charged. This parameter only applies to charge-items.
\n* contract_termination -when a contract term is terminated\n.
\n* subscription_creation -the time of creation of the subscription.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* on_demand -Item can be charged on demand
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
The unique ID of the business entity for this attached_item. This is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the business_entity_id will not be included in the API response.
Note: An alternative way of passing this parameter is by using a custom HTTP header or query string parameter.
\n", "maxLength" : 50, "example" : null } }, "required" : [ "item_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "attached_item" : { "$ref" : "#/components/schemas/AttachedItem", "description" : "Resource object representing attached_item
" } }, "required" : [ "attached_item" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/attached_items/{attached-item-id}/delete" : { "post" : { "summary" : "Delete an attached item", "description" : "Deletes an attached addon or a charge item.\n", "operationId" : "delete_an_attached_item", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "attached-item-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/attached-item-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "parent_item_id" : { "type" : "string", "deprecated" : false, "description" : "The id of the addon or charge that is being attached to the plan-item.\n", "maxLength" : 100, "example" : null } }, "required" : [ "parent_item_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "attached_item" : { "$ref" : "#/components/schemas/AttachedItem", "description" : "Resource object representing attached_item
" } }, "required" : [ "attached_item" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/differential_prices/{differential-price-id}/delete" : { "post" : { "summary" : "Delete a differential price", "description" : "Delete a differential price using a differential_price_id\nand item_price_id\n.
The id of the item price (addon\nor charge\n) whose price should change according to the plan-item it is applied to.
Resource object representing differential_price
" } }, "required" : [ "differential_price" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/item_prices/{item-price-id}/differential_prices" : { "post" : { "summary" : "Create a differential price", "description" : "Create a differential price for addon item price, addon item price with tiered pricing, or charge item price.\n", "operationId" : "create_a_differential_price", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "item-price-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/item-price-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "parent_item_id" : { "type" : "string", "deprecated" : false, "description" : "The id of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard*\nor *Enterprise*\nplans-items mentioned in the [examples above](/docs/api/differential_prices)\n.\n", "maxLength" : 100, "example" : null }, "price" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The differential price. If the pricing model of the item_price_id\nis tiered\n, volume\n, or stairstep\n, pass tiers\ninstead of this.
The price of the item when the pricing_model is flat_fee.\nWhen the pricing model is per_unit\n, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when multi-decimal pricing\nis enabled.
The unique ID of the business entity for this differential_price. This is applicable only when multiple business entities have been created for the site. When provided, the operation will read or write data associated with the specified business entity. If not provided, the resource will be created at the site level, and the business_entity_id will not be included in the API response.
Note: An alternative way of passing this parameter is by using a custom HTTP header or query string parameter.
\n", "maxLength" : 50, "example" : null }, "parent_periods" : { "type" : "object", "deprecated" : false, "description" : "Parameters for parent_periods\n", "properties" : { "period_unit" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "The unit of time for period\n.
A period of 1 calendar month.
\n* day -A period of 24 hours.
\n* week -A period of 7 days.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The billing period of the plan in period_unit\ns. For example, a 6 month plan has period\nas 6 and period_unit\nas month.
Note\nFor a charge-item price,
parent_periods[period_unit] and parent_periods[period] values are passed, then the price is applied to a specific billing frequency of the plan-item.parent_periods[period_unit] and parent_periods[period] values are not passed, then the price is applied to all billing frequencies of the plan-item.parent_periods[period] value is not passed, then the price is applied to all parent_periods[period_unit] (eg. monthly) frequencies of the plan-item. Updating or deleting the price after creation will impact all of its related plan-item frequencies.The per-unit price for the tier when the pricing_model\nis tiered\nor volume\n; the total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency\n.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the addon. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing differential_price
" } }, "required" : [ "differential_price" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/differential_prices" : { "get" : { "summary" : "List differential prices", "description" : "Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).\n", "operationId" : "list_differential_prices", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, string filter
\nThe id of the item price (addon\nor charge\n) whose price should change according to the plan-item it is applied to.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nitem_price_id[is] = "day-pass-USD"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "day-pass-USD", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "item_id", "in" : "query", "description" : "optional, string filter\n\nItem Id of Addon / Charge item price for which differential pricing is applied to.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*item_id\\[is\\] = \"day-pass\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "day-pass", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "id", "in" : "query", "description" : "optional, string filter\n\nA unique and immutable id for the differential price. It is auto-generated when the differential price is created.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is\\] = \"defcc4f1-f21f-47f4-8019-beddb9beab5f\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "defcc4f1-f21f-47f4-8019-beddb9beab5f", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "parent_item_id", "in" : "query", "description" : "optional, string filter\n\nThe id of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard*\nor *Enterprise*\nplans-items mentioned in the [examples above](/docs/api/differential_prices)\n.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*parent_item_id\\[is_not\\] = \"basic\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "basic", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "differential_price" : { "$ref" : "#/components/schemas/DifferentialPrice", "description" : "Resource object representing differential_price" } }, "required" : [ "differential_price" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/differential_prices/{differential-price-id}" : { "get" : { "summary" : "Retrieve a differential price", "description" : "Retrieve a differential price using a differential_price_id\nand item_price_id\n.
The id of the item price (addon\nor charge\n) whose price should change according to the plan-item it is applied to.
Resource object representing differential_price
" } }, "required" : [ "differential_price" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a differential price", "description" : "Update a differential price using a differential_price_id\nand item_price_id\n.
The id of the item price (addon\nor charge\n) whose price should change according to the plan-item it is applied to.
The differential price. If the pricing model of the item_price_id\nis tiered\n, volume\n, or stairstep\n, pass tiers\ninstead of this.
The price of the item when the pricing_model is flat_fee.\nWhen the pricing model is per_unit\n, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when multi-decimal pricing\nis enabled.
The unit of time for period\n.
A period of 1 calendar month.
\n* day -A period of 24 hours.
\n* week -A period of 7 days.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "period" : { "type" : "array", "description" : "The billing period of the plan in period_unit\ns. For example, a 6 month plan has period\nas 6 and period_unit\nas month.
Note\nFor a charge-item price,
parent_periods[period_unit] and parent_periods[period] values are passed, then the price is applied to a specific billing frequency of the plan-item.parent_periods[period_unit] and parent_periods[period] values are not passed, then the price is applied to all billing frequencies of the plan-item.parent_periods[period] value is not passed, then the price is applied to all parent_periods[period_unit] (eg. monthly) frequencies of the plan-item. Updating or deleting the price after creation will impact all of its related plan-item frequencies.The per-unit price for the tier when the pricing_model\nis tiered\nor volume\n; the total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency\n.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the addon. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Resource object representing differential_price
" } }, "required" : [ "differential_price" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/configurations" : { "get" : { "summary" : "List site configurations", "description" : "Returns a list of your domain and product catalog version details.\n", "operationId" : "list_site_configurations", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "configurations" : { "type" : "array", "description" : "Resource object representing configuration
", "items" : { "$ref" : "#/components/schemas/Configuration", "description" : "Resource object representing configuration" }, "example" : null } }, "required" : [ "configurations" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/features" : { "get" : { "summary" : "List features", "description" : "Retrieves a list of features meeting **all**\nthe conditions specified in the filter parameters.\n", "operationId" : "list_features", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, string filter
\nA case-sensitive unique name for the feature. For example: user license\n, data storage\n, Salesforce Integration\n, devices\n, UHD Streaming\n, and so on.
Note:\nThis name is not displayed on any customer-facing documents or pages such as invoice PDFs\nor hosted pages.\nHowever, in the future, it is likely to be introduced on the Self-Serve Portal\n.\nSupported operators :\nis, is_not, starts_with, in, not_in
\nExample →\nname[is] = "User licenses"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "User licenses", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "id", "in" : "query", "description" : "optional, string filter
\nA unique and immutable identifier for the feature. You can set it yourself, in which case it is recommended that a human-readable format (or slug) be used. For example, number-of-users-ccjht01.\nWhen not provided, a random value is automatically set.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nid[is] = "fea-user-licenses"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "fea-user-licenses", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "status", "in" : "query", "description" : "optional, enumerated string filter\n\nThe current status of the feature. Possible values are : active, archived, draft.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is\\] = \"active\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "active", "properties" : { "is" : { "type" : "string", "description" : "* `active` - Adraft or an archived feature can be changed to active. Any item or subscription entitlements defined for the feature take effect immediately.\n* `archived` - An active feature can be changed to archived. Once archived, no new item or subscription entitlements can be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was active, remain effective.\n* `draft` - The feature is in an unpublished state. Item and subscription entitlements can be created for a draft feature but they are not effective until the feature is active. A feature status cannot be changed back to draft once it is in active or archived status.",
"enum" : [ "active", "archived", "draft" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `active` - A draft or an archived feature can be changed to active. Any item or subscription entitlements defined for the feature take effect immediately.\n* `archived` - An active feature can be changed to archived. Once archived, no new item or subscription entitlements can be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was active, remain effective.\n* `draft` - The feature is in an unpublished state. Item and subscription entitlements can be created for a draft feature but they are not effective until the feature is active. A feature status cannot be changed back to draft once it is in active or archived status.",
"enum" : [ "active", "archived", "draft" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `active` - A draft or an archived feature can be changed to active. Any item or subscription entitlements defined for the feature take effect immediately.\n* `archived` - An active feature can be changed to archived. Once archived, no new item or subscription entitlements can be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was active, remain effective.\n* `draft` - The feature is in an unpublished state. Item and subscription entitlements can be created for a draft feature but they are not effective until the feature is active. A feature status cannot be changed back to draft once it is in active or archived status.",
"enum" : [ "active", "archived", "draft" ],
"pattern" : "^\\[(active|archived|draft)(,(active|archived|draft))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `active` - A draft or an archived feature can be changed to active. Any item or subscription entitlements defined for the feature take effect immediately.\n* `archived` - An active feature can be changed to archived. Once archived, no new item or subscription entitlements can be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was active, remain effective.\n* `draft` - The feature is in an unpublished state. Item and subscription entitlements can be created for a draft feature but they are not effective until the feature is active. A feature status cannot be changed back to draft once it is in active or archived status.",
"enum" : [ "active", "archived", "draft" ],
"pattern" : "^\\[(active|archived|draft)(,(active|archived|draft))*\\]$",
"example" : null
}
}
}
}, {
"name" : "type",
"in" : "query",
"description" : "optional, enumerated string filter\n\nThe type of feature. Possible values are : switch, custom, quantity, range.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*type\\[is\\] = \"boolean\"*\n",
"required" : false,
"deprecated" : false,
"style" : "deepObject",
"explode" : true,
"schema" : {
"type" : "object",
"deprecated" : false,
"example" : "boolean",
"properties" : {
"is" : {
"type" : "string",
"description" : "* `switch` - A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.\n* `custom` - The entitlement levels available for this feature are defined as a set of custom values. For example, a feature Email Support can have entitlement levels as 24×7 and 24×5.\n* `quantity` - The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with name such as number of users can have entitlement levels of say, 5, 20, 50, and 100. levels[is_unlimited] is used for specifying the “unlimited” entitlement level.\n* `range` - The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as number of users can have entitlement levels starting at 5 users and go up to 50000. levels[is_unlimited] is used for specifying the “unlimited” entitlement level.",
"enum" : [ "switch", "custom", "quantity", "range" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `switch` - A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.\n* `custom` - The entitlement levels available for this feature are defined as a set of custom values. For example, a feature Email Support can have entitlement levels as 24×7 and 24×5.\n* `quantity` - The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with name such as number of users can have entitlement levels of say, 5, 20, 50, and 100. levels[is_unlimited] is used for specifying the “unlimited” entitlement level.\n* `range` - The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as number of users can have entitlement levels starting at 5 users and go up to 50000. levels[is_unlimited] is used for specifying the “unlimited” entitlement level.",
"enum" : [ "switch", "custom", "quantity", "range" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `switch` - A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.\n* `custom` - The entitlement levels available for this feature are defined as a set of custom values. For example, a feature Email Support can have entitlement levels as 24×7 and 24×5.\n* `quantity` - The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with name such as number of users can have entitlement levels of say, 5, 20, 50, and 100. levels[is_unlimited] is used for specifying the “unlimited” entitlement level.\n* `range` - The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as number of users can have entitlement levels starting at 5 users and go up to 50000. levels[is_unlimited] is used for specifying the “unlimited” entitlement level.",
"enum" : [ "switch", "custom", "quantity", "range" ],
"pattern" : "^\\[(switch|custom|quantity|range)(,(switch|custom|quantity|range))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `switch` - A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.\n* `custom` - The entitlement levels available for this feature are defined as a set of custom values. For example, a feature Email Support can have entitlement levels as 24×7 and 24×5.\n* `quantity` - The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with name such as number of users can have entitlement levels of say, 5, 20, 50, and 100. levels[is_unlimited] is used for specifying the “unlimited” entitlement level.\n* `range` - The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as number of users can have entitlement levels starting at 5 users and go up to 50000. levels[is_unlimited] is used for specifying the “unlimited” entitlement level.",
"enum" : [ "switch", "custom", "quantity", "range" ],
"pattern" : "^\\[(switch|custom|quantity|range)(,(switch|custom|quantity|range))*\\]$",
"example" : null
}
}
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"list" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"feature" : {
"$ref" : "#/components/schemas/Feature",
"description" : "Resource object representing feature"
}
},
"required" : [ "feature" ],
"example" : null
},
"example" : null
},
"next_offset" : {
"type" : "string",
"description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.",
"maxLength" : 1000,
"example" : null
}
},
"required" : [ "list" ],
"example" : null
}
}
}
},
"400" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/400"
}
}
}
},
"401" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/401"
}
}
}
},
"403" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/403"
}
}
}
},
"404" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/404"
}
}
}
},
"405" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/405"
}
}
}
},
"409" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/409"
}
}
}
},
"422" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/422"
}
}
}
},
"429" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/429"
}
}
}
},
"500" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/500"
}
}
}
},
"503" : {
"description" : "on error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/503"
}
}
}
}
},
"deprecated" : false,
"security" : [ {
"BasicAuth" : [ ]
} ]
},
"post" : {
"summary" : "Create a feature",
"description" : "Creates a new feature.\n",
"operationId" : "create_a_feature",
"parameters" : [ {
"name" : "chargebee-request-origin-device",
"in" : "header",
"description" : "The device from which the customer has made the request\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-device",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "The device from which the customer has made the request\n",
"example" : "Android"
}
}, {
"name" : "chargebee-request-origin-user",
"in" : "header",
"description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-user",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"format" : "email",
"description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n",
"example" : "user@example.com"
}
}, {
"name" : "chargebee-request-origin-user-encoded",
"in" : "header",
"description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"format" : "email",
"description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n",
"example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
}
}, {
"name" : "chargebee-request-origin-ip",
"in" : "header",
"description" : "The IP address of the customer where the request originated\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-request-origin-ip",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "The IP address of the customer where the request originated\n",
"example" : "192.168.1.2",
"pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
}
}, {
"name" : "chargebee-event-actions",
"in" : "header",
"description" : "skip all actions to be done on the events\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-event-actions",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "skip all actions to be done on the events\n",
"enum" : [ "all-disabled" ],
"example" : null
}
}, {
"name" : "chargebee-event-email",
"in" : "header",
"description" : "skip only emails\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-event-email",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "skip only emails\n",
"enum" : [ "all-disabled" ],
"example" : null
}
}, {
"name" : "chargebee-event-webhook",
"in" : "header",
"description" : "skip only webhooks\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-event-webhook",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "skip only webhooks\n",
"enum" : [ "all-disabled" ],
"example" : null
}
}, {
"name" : "chargebee-business-entity-id",
"in" : "header",
"description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n",
"required" : false,
"deprecated" : false,
"$ref" : "#/components/parameters/chargebee-business-entity-id",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n",
"maxLength" : 50,
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"additionalProperties" : true,
"properties" : {
"id" : {
"type" : "string",
"deprecated" : false,
"description" : "A unique and immutable identifier for the feature. You can set it yourself, in which case it is recommended that a human-readable format (or slug) be used. For example, number-of-users-ccjht01.\nWhen not provided, a random value is automatically set.
A case-sensitive unique name for the feature. For example: user license\n, data storage\n, Salesforce Integration\n, devices\n, UHD Streaming\n, and so on.
Note:\nThis name is not displayed on any customer-facing documents or pages such as invoice PDFs\nor hosted pages.\nHowever, in the future, it is likely to be introduced on the Self-Serve Portal\n.
", "maxLength" : 50, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "A brief description of the feature. For example: Access to 10TB cloud storage\n.
The type of feature.
\n* quantity -The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with name\nsuch as number of users\ncan have entitlement levels of say, 5\n, 20\n, 50\n, and 100.\nlevels[is_unlimited]\nis used for specifying the "unlimited" entitlement level.
The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as number of users\ncan have entitlement levels starting at 5\nusers and go up to 50000.\nlevels[is_unlimited]\nis used for specifying the "unlimited" entitlement level.
A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.
\n* custom -The entitlement levels available for this feature are defined as a set of custom values. For example, a feature Email Support\ncan have entitlement levels as 24×7\nand 24×5\n.
The current status of the feature.
\n* active -A draft\nor an archived\nfeature can be changed to active.\nAny entitlements\nor subscription entitlements\ndefined for the feature take effect immediately.
The feature is in an unpublished state. Entitlements\nand subscription entitlements\ncan be created for a draft feature but they are not effective until the feature is active. A feature status\ncannot be changed back to draft\nonce it is in active\nor archived\nstatus\n.
An active\nfeature can be changed to archived.\nOnce archived\n, no new\nentitlements\nor subscription entitlements\ncan be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was active\n, remain effective.
For features of type\nquantity\nor range\n, this specifies the unit of measure. The value is expected in the singular form and when used by the system, it is pluralized automatically as needed. For example, for a feature such as user licenses\n, the unit\ncan be license\n.
A case-sensitive display name for the entitlement level. Provide a name that helps you clearly identify the entitlement level. For example: a feature such as Email Support\ncan have entitlement levels named as All weekdays\n, All days\n, 40 hours per week\nand so on.
When not provided for feature.type\nquantity\nor range\n, this name is auto-generated as the space-separated concatenation of levels[].value\nand the pluralized version of unit.\nFor example, if levels[].value\nis 20\nand unit\nis user\n, then levels[].name\nbecomes 20 users\n.
The value denoting the entitlement level granted.
\ntype is quantity: this attribute denotes the quantity of units of the feature for this entitlement level. For example, a feature such as number of users can have levels[].value as 5, 20, 50, and 100. levels[].is_unlimited is used to set the entitlement level to "unlimited".type is range: there can be be only two elements in the levels[] array; one corresponding to the minimum value (levels[0]) and the other to the maximum value (levels[1]) of the range of possible entitlement levels. For example, a feature such as number of users may have levels[0].value = 5 and levels[1].value = 50000. When the upper limit is "unlimited", then levels[1].value is not set and levels[1].is_unlimited is true.type is custom: this attribute denotes the value of this custom entitlement level. For example, a feature Email Support can have levels[].value as one of say, 24×7 and 24×5.When type is quantity or range, this attribute indicates whether the entitlement level corresponds to unlimited units of the feature. Possible values are:
true: The entitlement level corresponds to unlimited units of the feature. levels[].value is ignored for this level. This can only be set for the level that has the highest value for levels[].level.false: The entitlement level does not correspond to unlimited units of the feature.Either this or levels[value] should be passed.
", "items" : { "type" : "boolean", "deprecated" : false, "example" : null }, "example" : null }, "level" : { "type" : "array", "description" : "Represents the order of the entitlement levels from lowest to highest.
\ntype is quantity or custom: Provide the level for the lowest entitlement level as 0, the next higher level as 1, followed by 2, and so on.type is range: Provide 0 for the minimum value and 1 for the maximum value in the range.When not defined, it is assumed as the index of the levels[] array.
Resource object representing feature
" } }, "required" : [ "feature" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/features/{feature-id}/delete" : { "post" : { "summary" : "Delete a feature", "description" : "Deletes a feature. Any entitlements and subscription entitlements defined for the feature are also removed. This action is not permissible when the status\nof the feature is active\n.
Resource object representing feature
" } }, "required" : [ "feature" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/features/{feature-id}" : { "get" : { "summary" : "Retrieve a feature", "description" : "Retrieve a specific feature using its ID.\n", "operationId" : "retrieve_a_feature", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "feature-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/feature-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "feature" : { "$ref" : "#/components/schemas/Feature", "description" : "Resource object representing feature
" } }, "required" : [ "feature" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a feature", "description" : "Updates a specific feature.
Note
The list of objects levels[] provided as part of this operation fully replaces the existing list of objects levels[] of the feature.
levelsThis section describes validations that are performed by Chargebee when modifying the levels list of objects for the feature, using this operation.
levelsAdding a new object to the levels[] list is allowed if and only if the feature type is quantity or custom
levelsRemoving an existing object in the levels[] list is not allowed if the value for that object is currently mapped to one or more item_entitlements or subscription_entitlements.
levelsNote
The validation described in this section is only applicable for features of type custom
If any of levels[].value are currently mapped to item_entitlements or subscription_entitlements, then the relative order of the corresponding levels[].level must be preserved when invoking this operation.
For example, consider that the levels[] list is currently in the state shown below. (For brevity, only the value and level key are shown here and the JSONs have been compacted.)
\n{\n "levels":[{\n "value":"email-basic",\n "level":0\n },{\n "value":"email-rise",\n "level":1\n },{\n "value":"email-advanced",\n "level":2\n },{\n "value":"email-pro",\n "level":3\n },{\n "value":"email-scale",\n "level":4\n }]\n}\n\nNow consider that email-rise, email-advanced, and email-pro have already been mapped to item_entitlements or subscription_entitlements. As seen in the above object, the relative order of levels[].level is such that email-rise < email-advanced < email-pro.
Invoking this API to change levels[] to the state below is allowed since the relative order of level corresponding to email-rise, email-advanced, and email-pro has been preserved.
\n{\n "levels":[{\n "value":"email-basic",\n "level":0\n },{\n "value":"email-rise",\n "level":1\n },{\n "value":"email-scale",\n "level":2\n },{\n "value":"email-advanced",\n "level":3\n },{\n "value":"email-pro",\n "level":4\n }]\n}\n\nHowever, changing levels[] to the state shown below is not permissible because the level of email-advanced is provided as greater than the level of email-pro, thereby disrupting the original order.
\n{\n "levels":[{\n "value":"email-basic",\n "level":0\n },{\n "value":"email-rise",\n "level":1\n },{\n "value":"email-pro",\n "level":2\n },{\n "value":"email-advanced",\n "level":3\n },{\n "value":"email-scale",\n "level":4\n }]\n}\n\nA case-sensitive unique name for the feature. For example: user license\n, data storage\n, Salesforce Integration\n, devices\n, UHD Streaming\n, and so on.
Note:\nThis name is not displayed on any customer-facing documents or pages such as invoice PDFs\nor hosted pages.\nHowever, in the future, it is likely to be introduced on the Self-Serve Portal\n.
", "maxLength" : 50, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "A brief description of the feature. For example: Access to 10TB cloud storage\n.
The current status of the feature.
\n* active -A draft\nor an archived\nfeature can be changed to active.\nAny entitlements\nor subscription entitlements\ndefined for the feature take effect immediately.
The feature is in an unpublished state. Entitlements\nand subscription entitlements\ncan be created for a draft feature but they are not effective until the feature is active. A feature status\ncannot be changed back to draft\nonce it is in active\nor archived\nstatus\n.
An active\nfeature can be changed to archived.\nOnce archived\n, no new\nentitlements\nor subscription entitlements\ncan be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was active\n, remain effective.
For features of type\nquantity\nor range\n, this specifies the unit of measure. The value is expected in the singular form and when used by the system, it is pluralized automatically as needed. For example, for a feature such as user licenses\n, the unit\ncan be license\n.
A case-sensitive display name for the entitlement level. Provide a name that helps you clearly identify the entitlement level. For example: a feature such as Email Support\ncan have entitlement levels named as All weekdays\n, All days\n, 40 hours per week\nand so on.
When not provided for feature.type\nquantity\nor range\n, this name is auto-generated as the space-separated concatenation of levels[].value\nand the pluralized version of unit.\nFor example, if levels[].value\nis 20\nand unit\nis user\n, then levels[].name\nbecomes 20 users\n.
The value denoting the entitlement level granted.
\ntype is quantity: this attribute denotes the quantity of units of the feature for this entitlement level. For example, a feature such as number of users can have levels[].value as 5, 20, 50, and 100. levels[].is_unlimited is used to set the entitlement level to "unlimited".type is range: there can be only two elements in the levels[] array; one corresponding to the minimum value (levels[0]) and the other to the maximum value (levels[1]) of the range of possible entitlement levels. For example, a feature such as number of users may have levels[0].value = 5 and levels[1].value = 50000. When the upper limit is "unlimited", then levels[1].value is not set and levels[1].is_unlimited is true.type is custom: this attribute denotes the value of this custom entitlement level. For example, a feature Email Support can have levels[].value as one of say, 24×7 and 24×5.Note
This must be provided exactly as it already exists for the feature if the value is currently mapped to an entitlements or subscription_entitlements.
When type is quantity or range, this attribute indicates whether the entitlement level corresponds to unlimited units of the feature. Possible values are:
true: The entitlement level corresponds to unlimited units of the feature. levels[].value is ignored for this level. This can only be set for the level that has the highest value for levels[].level.false: The entitlement level does not correspond to unlimited units of the feature.Either this or levels[value] should be passed.
", "items" : { "type" : "boolean", "deprecated" : false, "example" : null }, "example" : null }, "level" : { "type" : "array", "description" : "Represents the order of the entitlement levels from lowest to highest.
\ntype is quantity: Provide the level for the lowest entitlement level as 0, the next higher level as 1, followed by 2, and so on.type is custom: Provide the level for the lowest entitlement level as 0, the next higher level as 1, followed by 2, and so on. Note: There are some validations to be considered.type is range: Provide 0 for the minimum value and 1 for the maximum value in the range.When not defined, it is assumed as the index of the levels[] array.
Resource object representing feature
" } }, "required" : [ "feature" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/features/{feature-id}/archive_command" : { "post" : { "summary" : "Archive a feature", "description" : "Archives an active\nfeature so that no new\nentitlements\nor subscription entitlements\ncan be created towards the feature. Any pre-existing item or subscription entitlements from the time that the feature was active\nremain effective. This operation changes the status\nof the feature to archived\n. The feature status\nmust be active\nwhen calling this endpoint.
Resource object representing feature
" } }, "required" : [ "feature" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/features/{feature-id}/activate_command" : { "post" : { "summary" : "Activate a feature", "description" : "Activates a draft\nfeature so that any entitlements\nor subscription entitlements\ndefined towards it take effect immediately. This operation changes the status\nof the feature to active\n. The feature status\nmust be draft\nwhen calling this endpoint.
Resource object representing feature
" } }, "required" : [ "feature" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/features/{feature-id}/reactivate_command" : { "post" : { "summary" : "Reactivate a feature", "description" : "Reactivates an archived feature so that new\nentitlements\nor subscription entitlements\ncan be created towards the feature. This operation changes the status\nof the feature to active\n. The feature status\nmust be archived\nwhen calling this endpoint.
Resource object representing feature
" } }, "required" : [ "feature" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/subscription_entitlements/set_availability" : { "post" : { "summary" : "Enable or disable subscription entitlements", "description" : "Enables or disables specific subscription_entitlements for a subscription.
Specifies whether the subscription_entitlements\nare to be enabled or disabled.
The id\nof the feature towards which the subscription_entitlement\nis to be enabled or disabled. An error is returned if a subscription_entitlement\ndoes not exist for the feature.
Retrieves the list of subscription_entitlements for the subscription.
Note:
The components attribute is not returned for any of the subscription_entitlements. Use the retrieve operation(coming soon) to obtain the components.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Disabled by default
This endpoint is disabled by default. To enable it, contact Chargebee Support.
Tip
To retrieve subscription entitlements for a specific subscription, use the List subscription entitlements API.
Returns a list of customer_entitlement objects for the specified customer. The entitlements returned are for active subscriptions only. Specifically, these are subscriptions with a status of active or non_renewing.
Pagination works differently for this endpoint than other List endpoints in the Billing API. In other list endpoints, the limit parameter sets the limit on the total number of objects returned in the response. However, in this endpoint, the limit parameter defines the number of features for which the customer_entitlement objects are returned. For example, if limit = n, then all customer_entitlement objects for up to n features are returned.
Let's look at an example:
Consider the following three features defined in Chargebee for a project management software:
The feature objects are listed below:
\n{\n "feature": {\n "id": "user-licenses",\n "name": "User Licenses",\n "description": "Maximum number of user licenses allowed.",\n "status": "active",\n "type": "quantity",\n "unit": "licence",\n "levels": [\n {\n "name": "3 licences",\n "value": "3",\n "is_unlimited": false,\n "level": 1\n },\n {\n "name": "10 licences",\n "value": "10",\n "is_unlimited": false,\n "level": 2\n },\n {\n "name": "25 licences",\n "value": "25",\n "is_unlimited": false,\n "level": 3\n },\n {\n "name": "Unlimited licence",\n "value": "Unlimited",\n "is_unlimited": true,\n "level": 4\n }\n ],\n "object": "feature"\n }\n}\n\n\n{\n "feature": {\n "id": "support-level",\n "name": "Support Level",\n "description": "Level of support offered.",\n "status": "active",\n "type": "custom",\n "levels": [\n {\n "name": "Email",\n "value": "Email",\n "is_unlimited": false,\n "level": 1\n },\n {\n "name": "Chat",\n "value": "Chat",\n "is_unlimited": false,\n "level": 2\n },\n {\n "name": "Calls",\n "value": "Calls",\n "is_unlimited": false,\n "level": 3\n }\n ],\n "object": "feature"\n }\n}\n\n\n{\n "feature": {\n "id": "xero-integration",\n "name": "Xero Integration",\n "description": "Integrate your Chargebee site with Xero",\n "status": "active",\n "type": "switch",\n "object": "feature"\n }\n}\n\nNow consider that a customer c1 has two subscriptions: s1 and s2.
Consider the following subscription entitlements for s1 and s2:
| Subscription id | Feature Name | Entitlement Value |
|---|---|---|
s1 | User Licenses | 3 |
s1 | Support Level | Email |
s2 | User Licenses | 10 |
s2 | Support Level | Chat |
s2 | Xero Integration | true |
API calls to this endpoint work as follows:
Consider the first call with limit set to 2.
\nGET /api/v2/customers/c1/customer_entitlements?limit=2\n\n\n{\n "list": [\n {\n "customer_entitlement": {\n "customer_id": "c1",\n "subscription_id": "s1",\n "feature_id": "user-licenses",\n "value": "3",\n "name": "3 licences",\n "is_enabled": true,\n "object": "customer_entitlement"\n }\n },\n {\n "customer_entitlement": {\n "customer_id": "c1",\n "subscription_id": "s2",\n "feature_id": "xero-integration",\n "value": "true",\n "name": "Available",\n "is_enabled": true,\n "object": "customer_entitlement"\n }\n },\n {\n "customer_entitlement": {\n "customer_id": "c1",\n "subscription_id": "s2",\n "feature_id": "user-licenses",\n "value": "10",\n "name": "10 licences",\n "is_enabled": true,\n "object": "customer_entitlement"\n }\n }\n ],\n "next_offset": "2"\n}\n\nSince limit = 2, the API returns the customer_entitlement for two features: User Licenses and Xero Integration. Three objects are returned, corresponding to rows 1, 3, and 5 in the table above.
We now retrieve the next page of the list in the second call by setting offset to the value of next_offset obtained from the previous response.
\n GET /api/v2/customers/c1/customer_entitlements?limit=2&offset=2\n\n\n{\n "list": [\n {\n "customer_entitlement": {\n "customer_id": "c1",\n "subscription_id": "s1",\n "feature_id": "support-level",\n "value": "Email",\n "name": "Email",\n "is_enabled": true,\n "object": "customer_entitlement"\n }\n },\n {\n "customer_entitlement": {\n "customer_id": "c1",\n "subscription_id": "s2",\n "feature_id": "support-level",\n "value": "Chat",\n "name": "Chat",\n "is_enabled": true,\n "object": "customer_entitlement"\n }\n }\n ]\n}\n\nAlthough limit = 2, the customer_entitlement objects for only one more feature, namely, Support Level are returned because the remaining were covered in the previous page. No more customer_entitlement objects remain for the customer, as indicated by the absence of the next_offset attribute in the response. The returned objects in this last call correspond to rows 2 and 4 in the table above.
The number of features for which to return customer_entitlement\nobjects.
See also\nPagination for List customer entitlements.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
When set to true\n, the response returns a unified view of entitlement values for each feature across the customer. This includes entitlements assigned directly to the customer as well as those inherited from any of the customer's subscriptions. In this mode, the subscription_id\nfield is omitted from the response objects. The consolidated entitlement value is derived using the same logic described in the Subscription Entitlements documentation\n, based on the feature type.
Deprecated\nThis operation is deprecated and no longer maintained. Migrate your integration to List entitlements.
Retrieves a list of all the item_entitlement\ns for the feature\nspecified.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Deprecated\nThis operation is deprecated and no longer maintained. Migrate your integration to Manage entitlements.
Warning\nThis operation is not supported when grandfathering is enabled.
Upserts or removes a set of item_entitlements for an feature depending on the action specified. The API returns the upserted or deleted item_entitlements after successfully completing the operation. The operation returns an error when the first item_entitlement fails to be processed. Either all the item_entitlements provided in the request are processed or none.
The specific action to be performed for each item_entitlement\nspecified.
Deletes the item_entitlement\nfor the feature_id\nand item_id\ncombination, if it exists.
If the item_entitlement\nalready exists for the feature_id\nand item_id\ncombination, the value\nof the item_entitlement\nis updated. If it doesn't exist, a new item_entitelment\nis created.
The id\nof the item\nto which this entitlement belongs.
The type\nof the item\nto which this entitlement belongs.
Plan
\n* item -Item
\n* subscription -Subscription
\n* addon -Addon
\n* charge -Charge
", "enum" : [ "plan", "addon", "charge", "subscription", "item" ], "example" : null }, "example" : null }, "value" : { "type" : "array", "description" : "The level of entitlement that the item has towards the feature. The possible values depend on the value of feature.type\n:
When feature.type is quantity and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any one of feature.levels[value][].
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can also be:
feature.levels[value][]unlimited (case-insensitive), indicating unlimited entitlement.When type is range and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any whole number between levels[value][0] and levels[value][1] (inclusive).
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can be:
levels[value][0]unlimited (case-insensitive), indicating unlimited entitlement.When type is custom, then the value can be any one of feature.levels[value][].
When type is switch, then the value is set as available or true.
Deprecated\nThis operation is deprecated and no longer maintained. Migrate your integration to List entitlements.
Retrieves a list of all the item_entitlements\nfor the item\nspecified.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Deprecated\nThis operation is deprecated and no longer maintained. Migrate your integration to Manage entitlements.
Warning\nThis operation is not supported when grandfathering is enabled.
Upserts or removes a set of item_entitlements for an item depending on the action specified. The API returns the upserted or deleted item_entitlements after successfully completing the operation. The operation returns an error when the first item_entitlement fails to be processed. Either all the item_entitlements provided in the request are processed or none.
The specific action to be performed for each item_entitlement\nspecified.
Deletes the item_entitlement\nfor the feature_id\nand item_id\ncombination, if it exists.
If the item_entitlement\nalready exists for the feature_id\nand item_id\ncombination, the value\nof the item_entitlement\nis updated. If it doesn't exist, a new item_entitelment\nis created.
The id\nof the feature towards which this entitlement has been granted.
The level of entitlement that the item has towards the feature. The possible values depend on the value of feature.type\n:
When feature.type is quantity and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any one of feature.levels[value][].
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can also be:
feature.levels[value][]unlimited (case-insensitive), indicating unlimited entitlement.When type is range and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any whole number between levels[value][0] and levels[value][1] (inclusive).
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can be:
levels[value][0]unlimited (case-insensitive), indicating unlimited entitlement.When type is custom, then the value can be any one of feature.levels[value][].
When type is switch, then the value is set as available or true.
Retrieves a list of all the entitlements associated with the specified feature.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, string filter
\nThe id\nof the feature associated with this entitlement.\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nfeature_id[is] = "user-licenses"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "user-licenses", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "entity_type", "in" : "query", "description" : "optional, enumerated string filter
\nThe type\nof the entity\nto which this entitlement belongs. Possible values are : plan, addon, charge, plan_price, addon_price.
Supported operators :\nis, is_not, in, not_in, in, not_in
\nExample →\nentity_type[in] = "plan_price"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "plan_price", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`plan\\` - Plan \\* \\`addon\\` - Addon \\* \\`charge\\` - Charge \\* \\`plan_price\\` - Plan Price \\* \\`addon_price\\` - Addon Price\n", "enum" : [ "plan", "addon", "charge", "plan_price", "addon_price" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`plan\\` - Plan \\* \\`addon\\` - Addon \\* \\`charge\\` - Charge \\* \\`plan_price\\` - Plan Price \\* \\`addon_price\\` - Addon Price\n", "enum" : [ "plan", "addon", "charge", "plan_price", "addon_price" ], "pattern" : "^\\[(plan|addon|charge|plan_price|addon_price)(,(plan|addon|charge|plan_price|addon_price))*\\]$", "example" : null } } } }, { "name" : "entity_id", "in" : "query", "description" : "optional, string filter
\nThe id\nof the entity\nto which this entitlement belongs. .\nSupported operators :\nis, is_not, starts_with, in, not_in
Example →\nentity_id[in] = "usd-professional-monthly"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "usd-professional-monthly", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "entitlement" : { "$ref" : "#/components/schemas/Entitlement", "description" : "Resource object representing entitlement" } }, "required" : [ "entitlement" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Manage entitlements for a feature", "description" : "Create, update, or remove a set of entitlements for a feature.
The behavior depends on the specified action. It tries to create, update, or delete entitlement objects. If any of the entitlement objects fail to process, the entire operation stops with an error, and no entitlements are processed. In essence, the request processes either all the provided entitlements or none of them.
\nEarly Access
\nGrandfathering in entitlements is in early access. Write to eap@chargebee.com to get this enabled.
\n
By default, this operation impacts all subscriptions that contain the item or item price. However, if you set apply_grandfathering to true, the existing subscriptions are not impacted by the change.
Consider the following example:
id: premium-monthly-usd) entitled to a feature (user_licenses) at value 10.id: AzZjAiTl1btqS2lEj) that contains the plan price (premium-monthly-usd).premium-monthly-usd for the user_licenses feature to value 20. You also set apply_grandfathering to true.id: 6oqNGUlMd9Yn4Ui) that contains the same plan price (premium-monthly-usd).id: AzZjAiTl1btqS2lEj) is grandfathered in, so it continues to be entitled to user_licenses at value 10. The new subscription (id: 6oqNGUlMd9Yn4Ui) is entitled to user_licenses at value 20.premium-monthly-usd for the user_licenses feature to value 30. You also set apply_grandfathering to false.id: 99CRh8UgMXTq77tl) that contains the same plan price (premium-monthly-usd).AzZjAiTl1btqS2lEj, 6oqNGUlMd9Yn4Ui, and 99CRh8UgMXTq77tl) are now entitled to user_licenses at value 30.The specific action to be performed for each entitlement\nspecified.
If the entitlement\nalready exists for the feature_id\nand entity_id\ncombination, the value\nof the entitlement\nis updated. If it doesn't exist, a new entitlement\nis created.
Deletes the entitlement\nfor the feature_id\nand entity_id\ncombination, if it exists.
The unique identifier of the entity being granted entitlement to a specific feature.
Note\nIn the case of an upsert action, if the entitlement resource does not already exist, Chargebee does not validate this ID to confirm its correspondence to an existing entity. The entitlement is created regardless.
The unique identifier of the feature to which the entity gains entitlement.
The type of the entity that holds this entitlement.
\n* plan -Indicates that the entity is an item with type set to plan.
Indicates that the entity is an item_price associated with an item with type set to addon.
Indicates that the entity is an item\nwith type\nset to charge\n.
Indicates that the entity is an item with type set to addon.
Indicates that the entity is an item_price associated with an item of type plan.
The level of entitlement that the entity has towards the feature. The possible values depend on the value of feature.type\n:
When feature.type is quantity and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any one of feature.levels[value][].
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can be:
feature.levels[value][]unlimited (case-insensitive), indicating unlimited entitlement.When type is range and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any whole number between levels[value][0] and levels[value][1] (inclusive).
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can be:
levels[value][0]unlimited (case-insensitive), indicating unlimited entitlement.When type is custom, then the value can be any one of feature.levels[value][].
When type is switch, then the value is set as available or true.
Early Access
Grandfathering support for entitlements is in early access. Write to eap@chargebee.com to get this enabled.
Determines whether to grandfather in existing subscriptions affected by this entitlement.
\ntrue: Existing subscriptions that contain this entity as one of the subscription items, are not mapped to this value of the entitlement; their currently mapped value for this entitlement are retained. New subscriptions created in the future that contain this entity, or existing subscriptions updated in the future to include this entity, are mapped to this value of the entitlement.false: All subscriptions that contain this entity are mapped to this version of the entitlement.This API verifies the application id {in_app_subscription_app_id} and receipt then returns the subscription details associated with the purchase.
in_app_subscription_app_id
required, string
The handle is created by Chargebee for your Apple App Store or Google Play Store app. It can be obtained from the Chargebee web app.\nThe following are instructions to obtain the value of the path parameter for the Apple App Store and Google Play Store.
{in_app_subscription_app_id}, click View Keys within the Sync Overview page of the web app and use the value of generated App ID for this parameter. See detailed steps here.{in_app_subscription_app_id}, click Set up notifications within the Sync Overview page of the web app and use the value of generated App ID for this parameter. See detailed steps here.Apple App Store: The Base64 encoded App Store in-app purchase receipt taken from the Apple device after successful creation of the in-app purchase subscription.\nGoogle Play Store: The purchase token taken from the Android device after the successful creation of an in-app purchase subscription.
Array of in_app_subscription object
", "items" : { "$ref" : "#/components/schemas/InAppSubscription", "description" : "Resource object representing in_app_subscription" }, "example" : null } }, "required" : [ "in_app_subscriptions" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/in_app_subscriptions/{in-app-subscription-app-id}/import_receipt" : { "post" : { "summary" : "Import Receipt", "description" : "Verifies an Apple App Store or Google Play Store in-app purchase receipt and imports subscriptions for all historical purchases made by the customer.
Tip\nAn in_app_subscription\nis created for every unique original_transaction_id\n. Apple creates original_transaction_id\nfor every create, upgrade, or downgrade of the subscription. A receipt hardly contains more than 100 original_transaction_id\ns. If a receipt contains more than 100 original_transaction_id\ns, Chargebee creates all subscription records but this endpoint returns the first 100 records in the response.
CSV upload has a file size limitation that increases the processing time and the number of receipts. This API removes such limitations and allows you to import historical in-app subscription receipts.
Note\n: This API verifies receipt or token through Apple or Google and then processes them via Chargebee. For bulk imports, limit API calls to 6\nper minute (10\nseconds apart) to ensure successful subscription imports.
This section provides details of the Import Receipt operation performed for the Apple App Store. This API processes only the historical in-app transaction receipts.
Important
Chargebee validates the receipt with Apple App Store and does the following once validation succeeds:
Subscriptions are imported as follows:
original_transaction_id in the Apple receipt.\nNote: This is not done for original_transaction_ids for which a subscription already exists in Chargebee.id set to original_transaction_id.start_date set to the earliest purchase_date_ms.current_term_start set to latest purchase_date_ms.current_term_end set to expires_date_ms of the same Latest_receipt_info element with the latest purchase_date_ms.item_price_id set to product_id.status set to in_trial if there is only one element of Latest_receipt_info with the original_transaction_id and the field is_trial_period is true, then consider the subscription is currently in trial. No invoices are created for this subscription.Invoices are imported as follows:
Latest_receipt_info which has is_trial_period as false.subscription_id set to original_transaction_id.A transaction is imported for each invoice with the following details:
reference_number set to the transaction_id.payment_method set to apple_store.This section provides details of the Import Receipt operation performed for the Google Play Store. This API is used to process only the historical in-app purchase subscriptions.
Important
token. If any other purchase token is passed instead of the latest one, there is a possibility of returning incorrect transaction details. If an expired purchase token is passed, then it returns an error.token expires, an API request to Google Developers API returns an error.Chargebee validates the purchase token with Google Play Store and does the following once validation succeeds:
A subscription is imported for every unique purchase token if it is not linked to an existing purchase token( linkedPurchaseToken field in SubscriptionsV2.get API Response).
Each subscription imported has the following attributes set:
\nid set to a unique identifier generated by Chargebee and mapped to the token and latestOrderId of the SubscriptionPurchaseV2 object from Google response.
start_date set to the earliest SubscriptionPurchaseV2.startTime.
current_term_start set to latest SubscriptionPurchaseV2.startTime.
current_term_end set to expiryTime of the same SubscriptionPurchaseV2 element with the latest purchase.
item_price_id set to the concatenation of product[id] and priceCurrencyCode from Google.
status set to in_trial if the free trial configuration is enabled in Google and the monetization.subscriptions.basePlans.offers.State is Active with a SubscriptionOfferPhase.duration, then consider the subscription is currently in trial. No invoices are created for this subscription.
Invoices are imported as follows:
An invoice is imported to Chargebee for every new subscription and renewal of an existing subscription using latestOrderId.
Each imported invoice has the subscription_id set to a unique identifier generated by Chargebee and mapped to the token and latestOrderId.
A transaction is imported for each invoice with the following details:
transaction.reference_number is set to the latestOrderId.
transaction.payment_method is set to play_store.
{in_app_subscription_app_id}: The handle created by Chargebee for your Apple App Store or Google Play Store app. It can be obtained from the Chargebee web app.\nThe following are instructions to obtain the value of the path parameter for the Apple App Store and Google Play Store.
{in_app_subscription_app_id}, click View Keys within the Sync Overview page of the web app and use the value of generated App ID for this parameter. See detailed steps here.{in_app_subscription_app_id}, click Set up notifications within the Sync Overview page of the web app and use the value of generated App ID for this parameter. See detailed steps here.Apple App Store: The Base64 encoded App Store in-app purchase receipt taken from the Apple device after successful creation of the in-app purchase subscription.\nGoogle Play Store: The purchase token taken from the Android device after the successful creation of an in-app purchase subscription.
Apple App Store: The unique id in Chargebee for the customer who made this purchase. If not provided, the value is considered to be original_transaction_id (the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.\nGoogle Play Store: The unique id of the customer who made this purchase via Google Play Store. This unique id will be used as customer ID within Chargebee. If not provided, subscription_id (random unique id) will be the customer ID. If the customer ID already exists in Chargebee then subscription will be associated with this customer ID.
Array of in_app_subscription object
", "items" : { "$ref" : "#/components/schemas/InAppSubscription", "description" : "Resource object representing in_app_subscription" }, "example" : null } }, "required" : [ "in_app_subscriptions" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/in_app_subscriptions/{in-app-subscription-app-id}/import_subscription" : { "post" : { "summary" : "Import Subscription Without Receipt", "description" : "The Import Subscriptions endpoint is a Chargebee API that allows you to import historic In-App Subscriptions without using a valid Apple App Store receipt. This endpoint is useful if you do not have access to the receipt data which is required for the Import Receipt API.\nWith this API, you can import subscriptions and corresponding invoices for historic In-App purchases. The API returns the in-app-subscriptions object once the historic subscription is successfully imported into Chargebee.
Note:
This section provides details of the Import Subscription operation when performed for the Apple App Store. This API creates a historic subscription if the incoming subscription is unknown. For a known subscription, it creates an invoice for the mentioned period.
Important
Integrate Chargebee with your Apple App Store account using your shared secret from Apple.
\nIt is strongly recommended to use this endpoint to create a historic In-App subscription only.
\nYou must import App Store products using Chargebee's user interface before importing receipts using this API.
\nChargebee validates the application ID with Apple App Store and does the following once validation succeeds:
Import the subscription from the latest_receipt_info array from Apple and a new subscription is imported for the item-price.\nNote: The subscription is not imported if it already exists in Chargebee but we will import the associated invoice using the subscription[transaction_id] in the payload.
Each subscription imported has the following attribute set:
\nid set to subscription[id] . This subscription[id] is original_transaction_id in the receipts.
start_date set to subscription[start_date]. You need to provide this information from the oldest Latest_receipt_info.purchase_date_ms.
term_start set to subscription[term_start]. You need to provide this information from the oldest Latest_receipt_info.purchase_date_ms).
term_end set to subscription[term_end]. You need to provide this information from the oldest Latest_receipt_info.expires_date_ms.
item_price_id set to subscription[product_id] + subscription[currency_code]. You need to provide this information from the Latest_receipt_info.product_id.
Chargebee records the subscription in a Trial state if the is_trial_period is true.
Chargebee records the subscription in a Canceled state if the term_end is less than the System.currentTime().
subscription_id set to original_transaction_id.\nTransactions for the invoiceThe transaction.reference_number is set to the transaction_id of the payment.
The transaction.payment_method is set to apple_store.
in_app_subscription_app_id
required, string
The handle created by Chargebee for your App Store app. It can be obtained from within the Chargebee web app. To obtain the value of in_app_subscription_app_id for the Apple App Store, click View Keys within the Sync Overview page of the web app, and use the value of generated App ID for this parameter. See detailed steps here.
This parameter is known as original_transaction_id in Apple App Store. You can get the value of original_transaction_id from the latest_receipt_info. The latest_receipt_info is an array that contains all in-app purchase transactions.
The time at which the subscription has started or going to be started. You can find this value from the oldest purchase_date_ms.
Start date of the billing period for the subscription. You can find it from the purchase_date_ms field in receipt payload.
End date of the billing period for the subscription. You can find it from the expires_date_ms field in receipt payload.
Transaction ID value as mentioned in the latest_receipt_info.\nThis must be unique across subscriptions.
Indicates if the subscription is in trial for the term start and term end. The default value is false\n.
The unique id in Chargebee for the customer who made this purchase. If not provided, the value is considered to be original_transaction_id (the transaction identifier at Apple, of the original purchase.). If the customer record is not found in Chargebee, it is created.
Resource object representing in_app_subscription
" } }, "required" : [ "in_app_subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/in_app_subscriptions/{in-app-subscription-app-id}/process_purchase_command" : { "post" : { "summary" : "Process Purchase Command", "description" : "Verifies an in-app purchase made by your customer and creates a subscription in Chargebee.
Note:\nIf App Store or Play Store products have not been imported to Chargebee and this API is invoked, Chargebee will automatically create plans that correspond to the store product IDs. However, if historical subscriptions are to be imported using the import receipt API, importing products is mandatory. Learn more.
This section provides details of the Process Purchase Command operation when performed for the Apple App Store. This API processes only the latest in-app transaction on the receipt. Sync historical subscriptions into Chargebee using bulk import of In-App Purchase receipts.
Important
Chargebee validates the receipt with Apple App Store and does the following once validation succeeds:
item_family.id that matches the value Apple-App-Store, and create such a product family if not found.item.id that matches product[id] and if not found, create such a plan-item under the item family described in the previous step.item_price.id that matches the concatenation of product[id] and product[currency_code], and if not found, create such an item price under the item described in the previous step.If the receipt is for a new purchase, a new subscription is created for the plan-item price described in the previous step. The subscription has the following details:
\nid set to original_transaction_id
start_date set to responseBody.Latest_receipt_info.purchase_date_ms
current_term_end set to responseBody.Latest_receipt_info.expires_date_ms
Instead, if the receipt belongs to an existing subscription in Chargebee, it is updated to reflect the current state of the subscription at Apple.
\ntransaction.reference_number is set to the transaction_id of the payment.transaction.payment_method is set to apple_pay.This section provides details of the Process Purchase Command operation when performed for the Google Play Store. This API processes only the latest in-app transaction using the purchase token.
Important
Chargebee validates the purchase token with Google Play Store and does the following once validation succeeds:
item_family.id that matches the value Google-Play-Store, and create such a product family if not found.item.id that matches product[id] and if not found, create such a plan-item under the item family described in the previous step.item_price.id that matches the concatenation of product[id] and priceCurrencyCode, and if not found, create such an item price under the item described in the previous step.If this token is for a new purchase, a new subscription is created for the plan-item price described in the previous step. The subscription has the following details:
\nid set to unique identifier generated by Chargebee and mapped to token of the SubscriptionPurchase object from Google response.
start_date set to SubscriptionPurchase.startTimeMillis.
current_term_end set to SubscriptionPurchase.expiryTimeMillis.
Instead, if the token belongs to an existing subscription in Chargebee, it is updated to reflect the current state of the subscription at Google.
\ntransaction.reference_number is set to the orderId of the payment.transaction.payment_method is set to play_store.{in_app_subscription_app_id}: The handle created by Chargebee for your Apple App Store or Google Play Store app. It can be obtained from the Chargebee web app.
The following are instructions to obtain the value of the path parameter for the Apple App Store and Google Play Store.
{in_app_subscription_app_id}, click View Keys within the Sync Overview page of the web app and use the value of generated App ID for this parameter. See detailed steps here.{in_app_subscription_app_id}, click Set up notifications within the Sync Overview page of the web app and use the value of generated App ID for this parameter. See detailed steps here.Apple App Store: The Base64 encoded App Store in-app purchase receipt taken from the Apple device after successful creation of the in-app purchase subscription.\nGoogle Play Store: The purchase token taken from the Android device after the successful creation of an in-app purchase subscription.
Google Play Store:\nThe unique identifier of the product purchased. The value of this parameter is the productId\n/subscriptionId\nor sku\nreceived from the Google Play Store.
Note:\nThe max chars\nlimit is 95\nfor Google Play Store.
Apple App Store:\nThe unique identifier\n(created in App Store Connect\n) of the product purchased.
", "maxLength" : 96, "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "**Google Play Store** :\nThis parameter is **not applicable**\nto the Google Play Store. If the value is passed, it will return a validation error.\n\n**Apple App Store**:\nThe currency code (ISO 4217 format) for the product.\n", "maxLength" : 3, "example" : null }, "price" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Google Play Store:\nThis parameter is not applicable\nto the Google Play Store. If the value is passed, it will return a validation error.
\nApple App Store:\nThe price paid by the customer for this product. The unit depends on the type of currency.\nProvide either this or product[price_in_decimal]\n.
Note:
product[price] is passed through this API then it will override the product price configured in Chargebee while creating a subscription.product[price] is passed and the product[id] does not exist in Chargebee then this API will return an error.product[price] passed through this API.Google Play Store:\nThe name (created in Play Store Console\n) of the product purchased. If not passed then the product[id]\nwill be considered as the value of product[name]\n.
optional, string, max chars=46
\nApple App Store:\nThe name (created in App Store Connect\n) of the product purchased.
", "maxLength" : 46, "example" : null }, "price_in_decimal" : { "type" : "string", "deprecated" : false, "description" : "Google Play Store:\nThis parameter is not applicable\nto the Google Play Store. If the value is passed, it will return a validation error.
\nApple App Store:\nThe price paid by the customer for the product. The value is in decimal and in major units of the currency. Provide either this or product[price]\n.
Google Play Store:\nThis parameter is not applicable\nto the Google Play Store. If the value is passed, it will return a validation error.
\nApple App Store:\nThis is the renewal period of the subscription. For example, 1, 2, 3, and so on. This is an optional\nparameter. The parameter value is required\nif the product(s) are not imported to Chargebee from Apple App Store.
Google Play Store:\nThis parameter is not applicable\nto the Google Play Store. If the value is passed, it will return a validation error.
\nApple App Store:\nThis is the unit of the renewal period. For example, 0\nrepresents the day\n,1\nrepresents the week\n, 2\nrepresents the month\n, and 3\nrepresents the year.\nThis is an optional\nparameter. The parameter value is required\nif the product(s) are not imported to Chargebee from Apple App Store.
Note\nSince the Apple App Store receipt does not have the subscription renewal period information for trial subscriptions, product[period] and product[period_unit] are needed, to create a subscription in Chargebee with the trial period. If these parameters are not passed and the receipt has trial information then Chargebee will return a validation error.
Google Play Store:\nThe unique id\nin Chargebee for the customer who made this purchase via Google Play Store. If not provided, subscription_id\n(random unique id) will be the customer[id].\nIf the customer record is not found in Chargebee, it is created.
optional, string, max chars=50
\nApple App Store:\nThe unique id\nin Chargebee for the customer who made this purchase. If not provided, the value is considered to be original_transaction_id\n(the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.
Resource object representing in_app_subscription
" } }, "required" : [ "in_app_subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/non_subscriptions/{non-subscription-app-id}/one_time_purchase" : { "post" : { "summary" : "One time purchase", "description" : "This API is used to sync consumable, non-consumable, and non-renewing product payments in Chargebee.\n", "operationId" : "one_time_purchase", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "non-subscription-app-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/non-subscription-app-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "receipt" : { "type" : "string", "deprecated" : false, "description" : "Google Play Store:\nThe purchase token\ntaken from the Android device after successful creation of the in-app purchase.
Apple App Store:\nThe Base64 encoded App Store in-app purchase receipt\ntaken from the Apple device after successful creation of the in-app purchase.
", "maxLength" : 65000, "example" : null }, "product" : { "type" : "object", "deprecated" : false, "description" : "Parameters for product\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Google Play Store: The unique identifier of the product purchased. The value of this parameter is the productId or sku received from the Google Play Store.
Note:\nThe max chars\nlimit is 95\nfor the Google Play Store.
Apple App Store: The unique identifier (created in App Store Connect) of the product purchased.
", "maxLength" : 96, "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "**Google Play Store** :\nThis parameter is **not applicable**\nto the **Google Play Store**.\nIf the value is passed, it will return a validation error.\n\n**Apple App Store**:\nThe currency code (ISO 4217 format) for the product.\n", "maxLength" : 3, "example" : null }, "price" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Google Play Store:\nThis parameter is not applicable\nto the Google Play Store.\nIf the value is passed, it will return a validation error.
\nApple App Store:\nThe price paid by the customer for this product. The unit depends on the type of currency.\nProvide either this or product[price_in_decimal]\n.
Google Play Store:\nThe name (created in Play Store Console\n) of the product purchased. If not passed then the product[id]\nwill be considered as the value of product[name].
Apple App Store:\nThe name (created in App Store Connect\n) of the product purchased.
", "maxLength" : 96, "example" : null }, "price_in_decimal" : { "type" : "string", "deprecated" : false, "description" : "Google Play Store:\nThis parameter is not applicable to the Google Play Store. If the value is passed, it will return a validation error.
\nApple App Store: The price paid by the customer for the product. The value is in decimal and in major units of the currency. Provide either this or product[price].
Google Play Store:\nThe unique id\nin Chargebee for the customer who made this purchase via Google Play Store. If not provided, a random unique ID generated for the purchase token will be the customer[id].\nIf the customer record is not found in Chargebee, it is created.
Apple App Store:\nThe unique id\nin Chargebee for the customer who made this purchase. If not provided, the value is considered to be original_transaction_id\n(the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.
Resource object representing non_subscription
" } }, "required" : [ "non_subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/entitlement_overrides" : { "get" : { "summary" : "List entitlement overrides for a subscription", "description" : "Retrieve the list of entitlement overrides for a subscription.\n", "operationId" : "list_entitlement_overrides_for_a_subscription", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Upserts or removes a set of entitlement_overrides\nfor a subscription\ndepending on the action\nspecified. The API returns the upserted or deleted entitlement_overrides\nafter successfully completing the operation. The operation returns an error when the first entitlement_override\nfails to be processed. Either all the entitlement_overrides\nprovided in the request are processed or none.
The action to perform for each entitlement_override specified in the entitlement_overrides array.
If the entitlement_override for the subscription_id, feature_id, and entity_id combination already exists, the value of the entitlement_override is updated. If it doesn't exist, a new entitlement_override is created.
Deletes the entitlement_override for the subscription_id, feature_id, and entity_id combination, if it exists.
The id of the feature for which the entitlement override is being set.
The id of the entity at whose level the entitlement override is being set for the subscription. If the entity_id is not currently a part of the subscription, the entitlement_override takes effect as soon as the entity is added to the subscription.
The type of the entity at whose level the entitlement override is being set for the subscription.
\n* plan_price -Indicates that the entity is an item_price with item_type set to plan.
Indicates that the entity is an item with type set to charge.
Indicates that the entity is an item_price with item_type set to addon.
The level of entitlement that the item has towards the feature. The possible values depend on the value of feature.type\n:
When feature.type is quantity and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any one of feature.levels[value][].
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can also be:
feature.levels[value][]unlimited (case-insensitive), indicating unlimited entitlement.When type is range and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any whole number between levels[value][0] and levels[value][1] (inclusive).
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can be:
levels[value][0]unlimited (case-insensitive), indicating unlimited entitlement.When type is custom, then the value can be any one of feature.levels[value][].
When type is switch, then the value is set as true if the feature is available; it is set as false when the feature is unavailable.
The expiry date for the entitlement_override. The entitlement_override object is no longer returned after this date has passed.
Constraints
entity_id and entity_type are set.action must be upsert.The starting date and time for the entitlement override. It indicates when the override becomes effective.
\nConstraints
entity_id and entity_type are set.action must be upsert.Returns a list of business_entity_transfer resources meeting all the conditions specified in the filter parameters below. By default, this list is sorted by created_at in descending order (latest first).
Tip
To retrieve a history of all the business entity transfers for a resource, pass the filter parameters active_resource_id[is] and resource_type[].
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Filter business_entity_transfer resources based on resource_type.
Tip\nUse this filter along with active_resource_id[is] to retrieve the history of all the business entity transfers for a resource.
Filter business_entity_transfer\nresources based on resource_id\n.
Filter business_entity_transfer resources based on active_resource_id.
Tip\nUse this filter along with resource_type[] to retrieve the history of all the business entity transfers for a resource.
Important\nThis API will not work if you have specified a business entity in the custom HTTP header.
Transfers one or more customer resources from one business entity to another.
The transfer is executed by creating a copy of the customer resource. The original resource is deprecated, while the new copy becomes the active resource.
Transfers must always be initiated for an active customer resources and never for a deprecated resources.
A customer resource cannot be transferred more than three times in a single calendar year. For example, if already moved thrice in the year 2023, a customer resource can only be moved again in 2024.
The customer resource must not have any of the following:
An account hierarchy relationship.
subscription resource with
status in_trial orsubscription.has_scheduled_advance_invoices as true.)invoice resource with status as pending. (Close pending invoices before invoking this API.)
invoice resources that are advance invoices. (invoice.has_advance_charges as true.)
quote resources with status as open or accepted.
transaction resource with:
status as in_progress orstatus as success, type as authorization, and a non-zero amount_capturable.Non-zero unbilled_charges. (Invoice unbilled charges before invoking this API.)
Non-zero refundable_credits. (Apply credits to unpaid invoices before invoking this API.)
The customer resource must not be a gifter of a gift subscription with status scheduled or unclaimed.
When calling this endpoint, the active and deprecated resources are processed as follows:
For the active resource:
\nid and active_id are set to match the deprecated resource's id.business_entity_id is set to destination_business_entity_id parameter.For the deprecated resource:
\ncustomer and subscription resources, the value of active_id is set to match the resource id.id is changed to a new random value.When this API is endpoint is called, Chargebee blocks concurrent calls to incompatible POST operations.
When a resource is transferred more than once, each transfer deprecates the previous active resource and creates a new active resource.
\npayment_source resources linked to the customer are immediately transferred to the destination business entity.
subscription resources linked to the customer are transferred automatically to the destination business entity as follows:
active subscription resources are transferred on their next renewal.paused subscription resources are transferred when resumed.future subscription resources are transferred on their start_date.non_renewing and cancelled subscription resources are not transferred and remain linked to the deprecated customer resource.Other resources linked to the customer, such as invoice, quote, credit_note, and transaction, remain linked to the deprecated customer resource.
Deprecated customer and subscription resources are not returned in list APIs such as List customers or List subscriptions.
See also
The following example illustrates the transfer of a customer resource from a business entity (source) to another (destination). The example also shows how payment_source, subscription, and invoice resources attached to the customer resource are affected.
Imagine a customer\nresource with the id\nAb6dRFt\nbelonging to the business entity acme-us\n. This customer has a linked payment_source\n, subscription\n, and an invoice\n.
To transfer the customer resource to a new business entity acme-eu, you would call the endpoint as follows:
\ncurl https://{site}.chargebee.com/api/v2/business_entities/transfers \\\n-u {api_key}:\\\n-d active_resource_ids[0]="Ab6dRFt" \\\n-d destination_business_entity_ids[0]="acme-us" \\\n-d reason_code[0]="correction"\n \nThe customer resource is deprecated in favor of a new active customer resource. Notice that the id of the deprecated customer resource is transferred to the new, active customer resource. Meanwhile, the deprecated resource is assigned a new random id.
The payment_source resource is also deprecated and a new active payment_source resource is created and linked to the new customer resource. Here too, the active resource adopts the id of the deprecated payment_source, which in turn is assigned a new random id.
The subscription and invoice resources remain linked to the deprecated customer resource.
subscription resourcesWhen the subscription renews, it automatically transfers to the business entity of the active customer resource. This process mirrors the transfer of the customer resource, resulting in a new active subscription resource linked to the active customer resource and the business entity acme-eu.
The list of unique identifiers of the customer resources to be transferred. Each id must belong to an active customer resource.
Note\nIf a customer resource was deprecated because it was moved previously, you cannot move it again. Instead, move the active version of the resource. Do this by passing the active_id of the deprecated resource.
The list of unique identifiers of the business_entity resources to which the corresponding customer resource must be transferred.
The list of reasons\nfor changing the business entity of the corresponding customer\nresources.
Resource object representing business_entity_transfer\n.
Deprecated\nThe purchase resource and its associated operations on this page are deprecated. Avoid using them in your integrations. The ability to purchase multiple plans in a single subscription will be supported through the Subscriptions API in the future.
Creates a purchase resource. A purchase can contain one or more of the following:
subscription resource consists of item prices such that at least one of the item prices belongs to an item of type plan.)When you call this API, the invoices for the subscription(s) and one-time charge(s) are created immediately and not left unbilled\n.
Note
Providing shipping_addresses[] is required when the Orders feature has been enabled.
purchase_item groupsWhen creating a purchase, you must specify the group or index to which each item price belongs. You can do this by setting the purchase_items[index] for each item price. Item prices with the same purchase_items[index] belong to the same group.\nThe grouping of item prices allows you to specify the discounts[] applicable for each group and indicate which item prices should be added to any subscriptions you want to create. Groups can be one of two types:
The following subsections describe the types of groups in detail.
Note
You can specify up to 10 groups,
The total limit for group items for a single purchase is 60.
To create a subscription, specify a subscription group. A subscription group is a group of item prices that contains exactly one item price of type plan. To create multiple subscriptions, provide multiple subscription groups.
Note
A subscription group can have up to 20 non-plan item prices. To increase this limit to a maximum of 60, contact eap@chargebee.com.
Purchase API supports custom fields of Subscriptions, use the following format to specify custom fields in Purchase API: subscription_info[custom_field].
A one-time charge group is a group of charge item prices (i.e. item prices belonging to items of type charge). Charge item prices can be added to subscription groups as well. The charges within and across each one-time group must be unique.
Note
Discounts, both manual discounts and coupons, can be applied to groups by specifying the discounts[] array. The following table describes the method of application based on whether discounts[index][i] is provided:
discounts[index][i] is provided | discounts[index][i] is not provided | |
| Coupons |
|
|
| Manual discounts |
|
|
Indicates whether the primary payment source is replaced with this payment source. If a payment_intent\nobject is included in the request, replace_primary\ndefaults to true.\nFor all other cases, the default is false\n.
Parameters for payment_schedule
The identifier of the payment_schedule_scheme\n, used to create the payment schedules.
The part of the invoice.amount_due\nto be distributed across the payment schedules. If not specified, the entire invoice.amount_due\nis considered by default.
The quantity of the item price. Applicable only when the pricing model\nof the item price is anything other than flat_fee.\nYou can provide this value whether multi-decimal pricing\nis enabled or disabled.
The decimal representation of the quantity of the item purchased. By default multi-decimal pricing\nis enabled for purchase API, it is recommended to use the purchase_items[quantity_in_decimal][0..n]\nfor providing quantity-based item prices when multi-decimal pricing is enabled. When multi-decimal pricing is disabled provide the value in purchase_items[quantity][0..n]\n.
The index or identifier of the group\nto which this tier information belongs. This must be a value from the purchase_items[index]\narray.
The unique ID of the item price to which this tier information belongs. This must be a value from the purchase_items[item_price_id]\narray.
The lowest value of quantity in this tier; this is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the very next lower tier.
The highest value of quantity in this tier. For all other tiers,it must be equal to the starting_unit_in_decimal\nof the very next higher tier.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the total price of the item. The currency units in which this value is expressed depends\non the type of currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
The first name of the contact. This parameter is mandatory\nwhen providing shipping information.
The last name of the contact. This parameter is mandatory\nwhen providing shipping information.
Address line 1. This parameter is mandatory\nwhen providing shipping information.
The name of the city. This parameter is mandatory\nwhen providing shipping information.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.\nThis parameter is mandatory\nwhen providing shipping information.
Note:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Zip or postal code. The number of characters is validated according to the rules specified here.\nThis parameter is mandatory\nwhen providing shipping information.
The index or identifier of the group\nto which this discount or coupon information belongs. This must be a value from the purchase_items[index] array. When not provided, the coupon is applied to the first invoice only; irrespective of the values set for coupon.duration_typeor coupon.max_redemptions.
See also:
Applying discountsThe percentage of the discount. Applicable only for manual discounts. For any given array index i, provide discounts[percentage][i] or discounts[quantity][i] or discounts[amount][i]
See also:
Applying discountsThe discount quantity. Applicable only for manual discounts. For any given array index i, provide discounts[percentage][i] or discounts[quantity][i] or discounts[amount][i]
See also:
Applying discountsThe absolute value of the discount. The currency units in which this value is expressed depends on the type of currency. Applicable only for manual discounts.\nFor any given array index i, you can provide discounts[percentage][i] or discounts[quantity][i] or discounts[amount][i]
See also:
Applying discountsFor manual discounts, set this to false if this manual discount should be excluded from monthly recurring revenue (MRR) calculations for the site. The following prerequisites must be met to allow this parameter to be passed:
See also:\nApplying discounts
The index or identifier of the group\nto which this subscription information belongs. This must be a value from the purchase_items[index]\narray and the group must be a subscription group\n.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The index number of the subscription/one-time group to which the item price is added. Provide a unique number between 0\nand 9\n(inclusive) for each group that is to be created. To increase this limit, contact Chargebee Support
Action to be taken when the contract term completes.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and the subscription renews.
\n* cancel -Contract term completes and subscription is canceled.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
Resource object representing purchase
" } }, "required" : [ "purchase" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/purchases/estimate" : { "post" : { "summary" : "Estimates for purchase", "description" : "Deprecated\nThe purchase resource and its associated operations on this page are deprecated. Avoid using them in your integrations. The ability to purchase multiple plans in a single subscription will be supported through the Subscriptions API in the future.
Returns an estimate for creating a purchase resource. The operation works exactly like Create a purchase, except that only an estimate resource is returned without an actual purchase resource being created.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Specifies if the customer is liable for tax
\n* exempt -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.
", "enum" : [ "taxable", "exempt" ], "example" : null }, "entity_code" : { "type" : "string", "deprecated" : false, "description" : "The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)\n.\n\\* med2 -\n\nUS Medical Device Excise Tax with taxable sales tax\n\\* med1 -\n\nUS Medical Device Excise Tax with exempt sales tax\n\\* b -\n\nState government\n\\* c -\n\nTribe/Status Indian/Indian Band\n\\* a -\n\nFederal government\n\\* f -\n\nReligious organization\n\\* g -\n\nResale\n\\* d -\n\nForeign diplomat\n\\* e -\n\nCharitable or benevolent organization\n\\* j -\n\nDirect pay permit\n\\* k -\n\nDirect mail\n\\* h -\n\nCommercial agricultural production\n\\* i -\n\nIndustrial production/manufacturer\n\\* n -\n\nLocal government\n\\* l -\n\nOther or custom\n\\* m -\n\nEducational organization\n\\* r -\n\nNon-resident\n\\* p -\n\nCommercial aquaculture\n\\* q -\n\nCommercial Fishery\n", "enum" : [ "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "p", "q", "r", "med1", "med2" ], "example" : null }, "exempt_number" : { "type" : "string", "deprecated" : false, "description" : "Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption)\n.\n", "maxLength" : 100, "example" : null }, "exemption_details" : { "type" : "array", "deprecated" : false, "description" : "Indicates the exemption information. You can customize customer exemption based on specific Location, Tax level (Federal, State, County and Local), Category of Tax or specific Tax Name. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\nTo know more about what values you need to provide, refer to this [Avalara's API document](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/exemption/)\n.\n", "items" : { "example" : null }, "example" : null }, "customer_type" : { "type" : "string", "deprecated" : false, "description" : "Indicates the type of the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n\\* business -\n\nWhen the purchase is made at a place of business\n\\* residential -\n\nWhen the purchase is made by a customer for home use\n\\* industrial -\n\nWhen the purchase is made by an industrial business\n\\* senior_citizen -\n\nWhen the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks\n", "enum" : [ "residential", "business", "senior_citizen", "industrial" ], "example" : null } }, "example" : null }, "billing_address" : { "type" : "object", "deprecated" : false, "description" : "Parameters for billing_address\n", "properties" : { "line1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1\n", "maxLength" : 150, "example" : null }, "line2" : { "type" : "string", "deprecated" : false, "description" : "Address line 2\n", "maxLength" : 150, "example" : null }, "line3" : { "type" : "string", "deprecated" : false, "description" : "Address line 3\n", "maxLength" : 150, "example" : null }, "city" : { "type" : "string", "deprecated" : false, "description" : "The name of the city.\n", "maxLength" : 50, "example" : null }, "state_code" : { "type" : "string", "deprecated" : false, "description" : "The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The quantity of the item price. Applicable only when the pricing model\nof the item price is anything other than flat_fee.\nYou can provide this value whether multi-decimal pricing\nis enabled or disabled.
The decimal representation of the quantity of the item purchased. By default multi-decimal pricing\nis enabled for purchase API, it is recommended to use the purchase_items[quantity_in_decimal][0..n]\nfor providing quantity-based item prices when multi-decimal pricing is enabled. When multi-decimal pricing is disabled provide the value in purchase_items[quantity][0..n]\n.
The index or identifier of the group\nto which this tier information belongs. This must be a value from the purchase_items[index]\narray.
The unique ID of the item price to which this tier information belongs. This must be a value from the purchase_items[item_price_id]\narray.
The lowest value of quantity in this tier; this is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the very next lower tier.
The highest value of quantity in this tier. For all other tiers,it must be equal to the starting_unit_in_decimal\nof the very next higher tier.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the total price of the item. The currency units in which this value is expressed depends\non the type of currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
The first name of the contact. This parameter is mandatory\nwhen providing shipping information.
The last name of the contact. This parameter is mandatory\nwhen providing shipping information.
Address line 1. This parameter is mandatory\nwhen providing shipping information.
The name of the city. This parameter is mandatory\nwhen providing shipping information.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.\nThis parameter is mandatory\nwhen providing shipping information.
Note:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Zip or postal code. The number of characters is validated according to the rules specified here.\nThis parameter is mandatory\nwhen providing shipping information.
The index or identifier of the group\nto which this discount or coupon information belongs. This must be a value from the purchase_items[index] array. When not provided, the coupon is applied to the first invoice only; irrespective of the values set for coupon.duration_typeor coupon.max_redemptions.
See also:
Applying discountsThe percentage of the discount. Applicable only for manual discounts. For any given array index i, provide discounts[percentage][i] or discounts[quantity][i] or discounts[amount][i]
See also:
Applying discountsThe discount quantity. Applicable only for manual discounts. For any given array index i, provide discounts[percentage][i] or discounts[quantity][i] or discounts[amount][i]
See also:
Applying discountsThe absolute value of the discount. The currency units in which this value is expressed depends on the type of currency. Applicable only for manual discounts.
\nFor any given array index i, provide discounts[percentage][i] or discounts[quantity][i] or discounts[amount][i]
See also:
Applying discountsFor manual discounts, set this to false if this manual discount should be excluded from monthly recurring revenue (MRR) calculations for the site. The following prerequisites must be met to allow this parameter to be passed:
See also:\nApplying discounts
The index or identifier of the group\nto which this subscription information belongs. This must be a value from the purchase_items[index]\narray and the group must be a subscription group\n.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The index number of the subscription/one-time group to which the item price is added. Provide a unique number between 0\nand 9\n(inclusive) for each group that is to be created. To increase this limit, contact Chargebee Support
Action to be taken when the contract term completes.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and the subscription renews.
\n* cancel -Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "example" : null }, "cancellation_cutoff_period" : { "type" : "array", "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/payment_vouchers" : { "get" : { "summary" : "List vouchers for a customer", "description" : "Retrieves vouchers for a customer in reverse chronological order.\n", "operationId" : "list_vouchers_for_a_customer", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "customer-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/customer-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The number of resources to be returned.\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Retrieves a voucher using the unique payment_voucher_id\n.
Resource object representing payment_voucher
" } }, "required" : [ "payment_voucher" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_vouchers" : { "post" : { "summary" : "Create a voucher for the customer to initiate payment", "description" : "Creates a voucher type payment source. If you create this voucher type payment source using customer details, like tax ID, you can then generate a voucher with that payment source.\n", "operationId" : "create_a_voucher_for_the_customer_to_initiate_payment", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "customer_id" : { "type" : "string", "deprecated" : false, "description" : "The unique identifier of the customer for whom you want to create the voucher.\n", "maxLength" : 50, "example" : null }, "payment_source_id" : { "type" : "string", "deprecated" : false, "description" : "The identifier of the payment source used for generating the voucher.\n", "maxLength" : 40, "example" : null }, "voucher_payment_source" : { "type" : "object", "deprecated" : false, "description" : "Parameters for voucher_payment_source\n", "properties" : { "voucher_type" : { "type" : "string", "deprecated" : false, "description" : "The type of voucher-based payment source.\n\\* boleto -\n\nThe payment source is Boleto.\n", "enum" : [ "boleto" ], "example" : null } }, "required" : [ "voucher_type" ], "example" : null }, "invoice_allocations" : { "type" : "object", "deprecated" : false, "description" : "Parameters for invoice_allocations
Resource object representing payment_voucher
" } }, "required" : [ "payment_voucher" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/csv_tax_rules" : { "post" : { "summary" : "Taxes Csv import", "operationId" : "taxes_csv_import", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "tax_profile_name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "country" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "default" : "*", "deprecated" : false, "maxLength" : 50, "example" : null }, "zip_code" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "zip_code_start" : { "type" : "integer", "format" : "int32", "deprecated" : false, "example" : null }, "zip_code_end" : { "type" : "integer", "format" : "int32", "deprecated" : false, "example" : null }, "tax1_name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "tax1_rate" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0, "example" : null }, "tax1_juris_type" : { "type" : "string", "deprecated" : false, "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ], "example" : null }, "tax1_juris_name" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax1_juris_code" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax2_name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "tax2_rate" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0, "example" : null }, "tax2_juris_type" : { "type" : "string", "deprecated" : false, "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ], "example" : null }, "tax2_juris_name" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax2_juris_code" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax3_name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "tax3_rate" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0, "example" : null }, "tax3_juris_type" : { "type" : "string", "deprecated" : false, "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ], "example" : null }, "tax3_juris_name" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax3_juris_code" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax4_name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "tax4_rate" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0, "example" : null }, "tax4_juris_type" : { "type" : "string", "deprecated" : false, "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ], "example" : null }, "tax4_juris_name" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax4_juris_code" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "service_type" : { "type" : "string", "deprecated" : false, "enum" : [ "digital", "other", "not_applicable" ], "example" : null }, "time_zone" : { "type" : "string", "deprecated" : false, "maxLength" : 4, "example" : null }, "valid_from" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "valid_till" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "overwrite" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "csv_tax_rule" : { "$ref" : "#/components/schemas/CsvTaxRule", "description" : "Resource object representing csv_tax_rule" } }, "required" : [ "csv_tax_rule" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/currencies/{site-currency-id}/add_schedule" : { "post" : { "summary" : "Add schedule", "description" : "This API is used to schedule exchange rate modification for a manual\nforex_type\ncurrency.
This parameter allows you to pass the exchange rate in decimal format. When forex_type\nis manual\nyou have to set the exchange rate for additional currencies in manual_exchange_rate\nparameter. A maximum of nine\ndecimal values are allowed to pass in this field.
Resource object representing currency
" } }, "required" : [ "currency", "scheduled_at" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/currencies" : { "post" : { "summary" : "Add a new currency", "description" : "This API is used to add a new currency to your Chargebee site. Prior to using this API, ensure that the multi-currency feature\nis enabled.\nIf the forex_type\nis set to manual\n, you can specify the manual_exchange_rate\n. Additionally, the currency code provided must adhere to the three-letter ISO standard currency codes.
This represents the exchange rate type set for the currency.
\n* auto -If forex_type\nis auto\n, conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)
If forex_type\nis manual\n, you will be able to set the conversion rate for the currency. You need to update the exchange rate each time your exchange rate provider changes it
This parameter allows you to pass the exchange rate in decimal format. When forex_type\nis manual\nyou have to set the exchange rate for additional currencies in manual_exchange_rate\nparameter. A maximum of nine\ndecimal values are allowed to pass in this field.
Resource object representing currency
" } }, "required" : [ "currency" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/currencies/{site-currency-id}" : { "get" : { "summary" : "Retrieve a currency", "description" : "This API is used to retrieve an individual currency object configured within this site.\n", "operationId" : "retrieve_a_currency", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "site-currency-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/site-currency-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "currency" : { "$ref" : "#/components/schemas/Currency", "description" : "Resource object representing currency
" } }, "required" : [ "currency" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a currency", "description" : "This API is used to update the configured currencies within your Chargebee site.\nAdditionally, If the forex_type\nis set to manual\n, you can specify the manual_exchange_rate\n.
This represents the exchange rate type set for the currency.
\n* auto -If forex_type\nis auto\n, conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)
If forex_type\nis manual\n, you will be able to set the conversion rate for the currency. You need to update the exchange rate each time your exchange rate provider changes it
This parameter allows you to pass the exchange rate in decimal format. When forex_type\nis manual\nyou have to set the exchange rate for additional currencies in manual_exchange_rate\nparameter. A maximum of nine\ndecimal values are allowed to pass in this field.
Resource object representing currency
" } }, "required" : [ "currency" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/currencies/{site-currency-id}/remove_schedule" : { "post" : { "summary" : "Remove schedule", "description" : "This API allows you to remove a scheduled exchange rate from a currency.\n", "operationId" : "remove_schedule", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "site-currency-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/site-currency-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "scheduled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "currency" : { "$ref" : "#/components/schemas/Currency", "description" : "Resource object representing currency
" } }, "required" : [ "currency", "scheduled_at" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/currencies/list" : { "get" : { "summary" : "List currencies", "description" : "This API is used to retrieve the list of all currencies currently configured within the site.\n", "operationId" : "list_currencies", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.\n", "maxLength" : 1000, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "currency" : { "$ref" : "#/components/schemas/Currency", "description" : "Resource object representing currency" } }, "required" : [ "currency" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/ramps/{ramp-id}" : { "get" : { "summary" : "Retrieve a subscription ramp", "description" : "Retrieves a specific subscription ramp.\n", "operationId" : "retrieve_a_ramp", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "ramp-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/ramp-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "ramp" : { "$ref" : "#/components/schemas/Ramp", "description" : "Resource object representing ramp
" } }, "required" : [ "ramp" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/create_ramp" : { "post" : { "summary" : "Create a subscription ramp", "description" : "Creates a ramp for a subscription.
Note
paused or cancelled status.status as scheduled.The time when this ramp takes effect.
\nCaution
effective_from of two consecutive ramps.pause_date or cancelled_at.Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -Used when you want to renew the contract term. Does the following:
\nrenewal_billing_cycles.action_at_term_end for the new contract term is set to renew.Used when you want to renew the contract term just once. Does the following:
\nrenewal_billing_cycles.action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The unique identifier of the item price.
\nCaution
Ensure this list does not include:
\nItem prices updated or removed through this ramp.
\nItem prices already in the subscription or added by a previous ramp.
\nThe ramp should not change the billing period of the subscription if an upcoming ramp already exists after effective_from time.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency\n.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* contract_termination -when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* immediately -The item is charged immediately on being added to the subscription.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency\n.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time when the trial period of the subscription begins.
\n* contract_termination -when a contract term is terminated\n.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
", "enum" : [ "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* immediately -The item is charged immediately on being added to the subscription.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
Note\nAllowed only when both of these conditions are met:
Replaces the existing item_tiers for specific item_prices within the subscription. You must provide the complete tier set for any item_price, even if you're changing the price for only one tier.
The identifier of the item_price\nfor which the tier price is being overridden.
Caution\nThe identifier must correspond to an item_price listed in either items_to_add or items_to_update.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The date till when the coupon can be applied. Applicable for limited_period\ncoupons\nonly.
The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* one_time -The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 7 days.
\n* year -A period of 1 calendar year.
\n* day -A period of 24 hours.
\n* month -A period of 1 calendar month.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Resource object representing ramp
" } }, "required" : [ "ramp" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/ramps" : { "get" : { "summary" : "List subscription ramps", "description" : "Lists the subscription ramps that match the criteria provided in the filter parameters.
Note\nBy default, the ramps are returned sorted in descending order (latest first) by updated_at.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
optional, enumerated string filter
\nFilter subscription ramps based on status\n.
Caution
subscription_id filter must be passed when filtering by status.status filter should not be passed when include_deleted is set to true.Possible values are : scheduled, succeeded, failed.
\nSupported operators :\nis, in
\nExample →\nstatus[is] = "SCHEDULED"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "SCHEDULED", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`scheduled\\` - Status of the subscription schedule on creation. \\* \\`succeeded\\` - The execution status of the schedule if success. \\* \\`failed\\` - The execution status of the schedule if failed. \\* \\`draft\\` - Status of the subscription schedule considering as draft\n", "enum" : [ "scheduled", "succeeded", "failed", "draft" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`scheduled\\` - Status of the subscription schedule on creation. \\* \\`succeeded\\` - The execution status of the schedule if success. \\* \\`failed\\` - The execution status of the schedule if failed. \\* \\`draft\\` - Status of the subscription schedule considering as draft\n", "enum" : [ "scheduled", "succeeded", "failed", "draft" ], "pattern" : "^\\[(scheduled|succeeded|failed|draft)(,(scheduled|succeeded|failed|draft))*\\]$", "example" : null } } } }, { "name" : "subscription_id", "in" : "query", "description" : "optional, string filter
\nFilter subscription ramps based on subscription_id\n.
Caution\nThis filter is mandatory when filtering by status or effective_from.
Supported operators :\nis, in
\nExample →\nsubscription_id[is] = "8gsnbYfsMLds"
", "required" : true, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "8gsnbYfsMLds", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "effective_from", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\nFilter subscription ramps based on effective_from.
Caution
subscription_id filter must be passed when filtering by effective_from.effective_from filter should not be passed when include_deleted is set to true.Supported operators :\nafter, before, on, between
\nExample →\neffective_from[after] = "1435054328"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1435054328", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "updated_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\nFilter subscription ramps based on updated_at\n.
Tip\nSpecify sort_by = updated_at (whether asc oor desc) for a faster response when using this filter.
Supported operators :\nafter, before, on, between
\nExample →\nupdated_at[after] = "1435052328"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1435052328", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\neffective_from, created_at, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"effective_from\"*\n\nThis will sort the result based on the 'effective_from' attribute in ascending(earliest first) order.\n", "required" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "additionalProperties" : true, "properties" : { "asc" : { "type" : "string", "enum" : [ "effective_from", "updated_at" ], "example" : null }, "desc" : { "type" : "string", "enum" : [ "effective_from", "updated_at" ], "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "ramp" : { "$ref" : "#/components/schemas/Ramp", "description" : "Resource object representing ramp" } }, "required" : [ "ramp" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/ramps/{ramp-id}/update" : { "post" : { "summary" : "Update a subscription ramp", "description" : "Updates an existing subscription ramp by replacing its current attribute values with the new parameters provided. When using this API to modify a ramp, make sure to include all the ramp's attributes as you would do during creation of the ramp with the necessary values updated.\nExample: step-by-step flow\nThe following steps explains how to update effective_from value of an existing ramp.
Step 1: Retrieve current ramp values
Step 2: Update ramp with new values
Note
succeeded or failed status.The time when this ramp takes effect.
\nCaution
effective_from of two consecutive ramps.pause_date or cancelled_at.Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -Used when you want to renew the contract term. Does the following:
\nrenewal_billing_cycles.action_at_term_end for the new contract term is set to renew.Used when you want to renew the contract term just once. Does the following:
\nrenewal_billing_cycles.action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles
or a custom value depending on the\nsite configuration\n.
", "example" : null } }, "example" : null }, "items_to_add" : { "type" : "object", "deprecated" : false, "description" : "Details about the \\[item prices\\](/docs/api/item_prices) added to the subscription through this ramp.\n", "properties" : { "item_price_id" : { "type" : "array", "description" : "The unique identifier of the item price.
\nCaution
Ensure this list does not include:
\nItem prices updated or removed through this ramp.
\nItem prices already in the subscription or added by a previous ramp.
\nThe ramp should not change the billing period of the subscription if an upcoming ramp already exists after effective_from time.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency\n.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* contract_termination -when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* immediately -The item is charged immediately on being added to the subscription.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency\n.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time when the trial period of the subscription begins.
\n* contract_termination -when a contract term is terminated\n.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
", "enum" : [ "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "example" : null }, "charge_once" : { "type" : "array", "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* immediately -The item is charged immediately on being added to the subscription.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
Note\nAllowed only when both of these conditions are met:
Replaces the existing item_tiers for specific item_prices within the subscription. You must provide the complete tier set for any item_price, even if you're changing the price for only one tier.
The identifier of the item_price\nfor which the tier price is being overridden.
Caution\nThe identifier must correspond to an item_price listed in either items_to_add or items_to_update.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "example" : null }, "package_size" : { "type" : "array", "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The date till when the coupon can be applied. Applicable for limited_period\ncoupons\nonly.
The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* one_time -The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 7 days.
\n* year -A period of 1 calendar year.
\n* day -A period of 24 hours.
\n* month -A period of 1 calendar month.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Resource object representing ramp
" } }, "required" : [ "ramp" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/ramps/{ramp-id}/delete" : { "post" : { "summary" : "Delete a subscription ramp", "description" : "Deletes the specified subscription ramp. However, Chargebee only allows deleting a ramp if it does not conflict with future ramps on the subscription. The following checks are performed to ensure compatibility:
| Condition | Restriction |
|---|---|
The ramp contains items_to_add[] | The ramp cannot be deleted if any of the items in items_to_add[] are scheduled to be updated or removed in a subsequent ramp. |
The ramp contains coupons_to_add[] | The ramp cannot be deleted if any of the coupons in coupons_to_add[] are scheduled to be removed in a subsequent ramp. |
The ramp contains discounts_to_add[] | The ramp cannot be deleted if any of the discounts in discounts_to_add[] are scheduled to be removed in a subsequent ramp. |
Resource object representing ramp
" } }, "required" : [ "ramp" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_schedule_schemes/{payment-schedule-scheme-id}" : { "get" : { "summary" : "Retrieve a payment schedule scheme", "description" : "This endpoint retrieves an existing payment schedule.\n", "operationId" : "retrieve_a_payment_schedule_scheme", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "payment-schedule-scheme-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/payment-schedule-scheme-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "payment_schedule_scheme" : { "$ref" : "#/components/schemas/PaymentScheduleScheme", "description" : "Resource object representing payment_schedule_scheme
" } }, "required" : [ "payment_schedule_scheme" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_schedule_schemes" : { "post" : { "summary" : "Create a payment schedule scheme", "description" : "Creates a payment schedule scheme. After creating a payment schedule scheme, you can use it to generate payment schedules for multiple invoices.\n", "operationId" : "create_a_payment_schedule_scheme", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "number_of_schedules" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Specifies the total number of payment schedules for the invoice. The maximum number_of_schedules\nvaries based on the period_unit\n: - Day: Up to 30 schedules
The time period between the effective dates of two consecutive payment schedules, expressed in period_units. Use this parameter to have fixed intervals between payment schedules. The maximum period\nvaries based on the period_unit\n: - Day: Up to 30 days
Resource object representing payment_schedule_scheme
" } }, "required" : [ "payment_schedule_scheme" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_schedule_schemes/{payment-schedule-scheme-id}/delete" : { "post" : { "summary" : "Delete a payment schedule scheme", "description" : "This endpoint deletes a payment schedules created for an invoice.\n", "operationId" : "delete_a_payment_schedule_scheme", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "payment-schedule-scheme-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/payment-schedule-scheme-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "payment_schedule_scheme" : { "$ref" : "#/components/schemas/PaymentScheduleScheme", "description" : "Resource object representing payment_schedule_scheme
" } }, "required" : [ "payment_schedule_scheme" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migrations/{pc2-migration-id}/contact_support" : { "post" : { "summary" : "Contact_support a pc2_migration", "operationId" : "contact_support_a_pc2_migration", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration" : { "$ref" : "#/components/schemas/Pc2Migration", "description" : "Resource object representing pc2_migration" } }, "required" : [ "pc2_migration" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migrations/{pc2-migration-id}" : { "get" : { "summary" : "Retrieve a pc2 migration", "operationId" : "retrieve_a_pc2_migration", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration" : { "$ref" : "#/components/schemas/Pc2Migration", "description" : "Resource object representing pc2_migration" } }, "required" : [ "pc2_migration" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migrations" : { "post" : { "summary" : "Create a pc2_migration", "operationId" : "create_a_pc2_migration", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration" : { "$ref" : "#/components/schemas/Pc2Migration", "description" : "Resource object representing pc2_migration" } }, "required" : [ "pc2_migration" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migrations/{pc2-migration-id}/initiate" : { "post" : { "summary" : "Initiate a pc2_migration", "operationId" : "initiate_a_pc2_migration", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration" : { "$ref" : "#/components/schemas/Pc2Migration", "description" : "Resource object representing pc2_migration" } }, "required" : [ "pc2_migration" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migration_item_families/{pc2-migration-item-family-id}/delete" : { "post" : { "summary" : "Delete draft family", "operationId" : "delete_draft_family", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-item-family-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-item-family-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "is_deleted" : { "type" : "boolean", "deprecated" : false, "example" : null } }, "required" : [ "is_deleted" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migration_item_families/{pc2-migration-item-family-id}" : { "get" : { "summary" : "Retrieve a pc2 migration item family", "operationId" : "retrieve_a_pc2_migration_item_family", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-item-family-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-item-family-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration_item_family" : { "$ref" : "#/components/schemas/Pc2MigrationItemFamily", "description" : "Resource object representing pc2_migration_item_family" } }, "required" : [ "pc2_migration_item_family" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a pc2_migration_item_family", "operationId" : "update_a_pc2_migration_item_family", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-item-family-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-item-family-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "is_default" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration_item_family" : { "$ref" : "#/components/schemas/Pc2MigrationItemFamily", "description" : "Resource object representing pc2_migration_item_family" } }, "required" : [ "pc2_migration_item_family" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migration_item_families" : { "get" : { "summary" : "List pc2 migration item families", "operationId" : "list_pc2_migration_item_families", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/limit", "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/offset", "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.\n", "maxLength" : 1000, "example" : null } }, { "name" : "pc2_migration_id", "in" : "query", "required" : true, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "description" : "pc2_migration reference key\n", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "pc2_migration_item_family" : { "$ref" : "#/components/schemas/Pc2MigrationItemFamily", "description" : "Resource object representing pc2_migration_item_family" } }, "required" : [ "pc2_migration_item_family" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Create a pc2_migration_item_family", "operationId" : "create_a_pc2_migration_item_family", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "is_default" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "pc2_migration_id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null } }, "required" : [ "id", "name", "pc2_migration_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration_item_family" : { "$ref" : "#/components/schemas/Pc2MigrationItemFamily", "description" : "Resource object representing pc2_migration_item_family" } }, "required" : [ "pc2_migration_item_family" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migration_items/{pc2-migration-item-id}" : { "get" : { "summary" : "Retrieve a pc2 migration item", "operationId" : "retrieve_a_pc2_migration_item", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-item-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-item-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration_item" : { "$ref" : "#/components/schemas/Pc2MigrationItem", "description" : "Resource object representing pc2_migration_item" } }, "required" : [ "pc2_migration_item" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a pc2_migration_item", "operationId" : "update_a_pc2_migration_item", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-item-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-item-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "id" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "pc2_migration_item_family_id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "metadata" : { "type" : "string", "deprecated" : false, "maxLength" : 65000, "example" : null }, "is_giftable" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "is_shippable" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "enabled_for_checkout" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "enabled_in_portal" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "redirect_url" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "is_recurring" : { "type" : "boolean", "default" : true, "deprecated" : false, "example" : null }, "gift_claim_redirect_url" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "included_in_mrr" : { "type" : "boolean", "deprecated" : false, "example" : null }, "unit" : { "type" : "string", "deprecated" : false, "maxLength" : 30, "example" : null }, "pc2_migration_item_prices" : { "type" : "object", "deprecated" : false, "properties" : { "id" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "name" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "description" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "example" : null }, "metadata" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "example" : null }, "ref_entity_id" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null } }, "required" : [ "name", "ref_entity_id" ], "example" : null } }, "example" : null }, "encoding" : { "pc2_migration_item_prices" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration_item" : { "$ref" : "#/components/schemas/Pc2MigrationItem", "description" : "Resource object representing pc2_migration_item" } }, "required" : [ "pc2_migration_item" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migration_items/{pc2-migration-item-id}/delete" : { "post" : { "summary" : "Delete draft item", "operationId" : "delete_draft_item", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-item-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-item-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "is_deleted" : { "type" : "boolean", "deprecated" : false, "example" : null } }, "required" : [ "is_deleted" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migration_items" : { "get" : { "summary" : "List pc2 migration items", "operationId" : "list_pc2_migration_items", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/limit", "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/offset", "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.\n", "maxLength" : 1000, "example" : null } }, { "name" : "pc2_migration_item_family", "in" : "query", "required" : true, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "description" : "Parameters for pc2_migration_item_family\n", "properties" : { "pc2_migration_id" : { "type" : "object", "deprecated" : false, "description" : "pc2_migration reference key\n", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } }, "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "pc2_migration_item" : { "$ref" : "#/components/schemas/Pc2MigrationItem", "description" : "Resource object representing pc2_migration_item" } }, "required" : [ "pc2_migration_item" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Create a pc2_migration_item", "operationId" : "create_a_pc2_migration_item", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "id" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "pc1_type" : { "type" : "string", "deprecated" : false, "enum" : [ "plan", "addon" ], "example" : null }, "pc2_migration_item_family_id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "pc2_migration_id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "metadata" : { "type" : "string", "deprecated" : false, "maxLength" : 65000, "example" : null }, "is_giftable" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "is_shippable" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "enabled_for_checkout" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "enabled_in_portal" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "redirect_url" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "is_recurring" : { "type" : "boolean", "default" : true, "deprecated" : false, "example" : null }, "gift_claim_redirect_url" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "included_in_mrr" : { "type" : "boolean", "deprecated" : false, "example" : null }, "unit" : { "type" : "string", "deprecated" : false, "maxLength" : 30, "example" : null }, "pc2_migration_item_prices" : { "type" : "object", "deprecated" : false, "properties" : { "id" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "name" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null }, "description" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "example" : null }, "metadata" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "example" : null }, "ref_entity_id" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "example" : null } }, "required" : [ "name", "ref_entity_id" ], "example" : null } }, "required" : [ "id", "name", "pc1_type", "pc2_migration_id" ], "example" : null }, "encoding" : { "pc2_migration_item_prices" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration_item" : { "$ref" : "#/components/schemas/Pc2MigrationItem", "description" : "Resource object representing pc2_migration_item" } }, "required" : [ "pc2_migration_item" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migration_items/applicable_items" : { "get" : { "summary" : "Applicable_items a pc2_migration_item", "operationId" : "applicable_items_a_pc2_migration_item", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/limit", "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/offset", "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.\n", "maxLength" : 1000, "example" : null } }, { "name" : "is_recurring", "in" : "query", "required" : true, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "pc2_migration_applicable_item" : { "$ref" : "#/components/schemas/Pc2MigrationApplicableItem", "description" : "Resource object representing pc2_migration_applicable_item" } }, "required" : [ "pc2_migration_applicable_item" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migration_item_prices" : { "get" : { "summary" : "List pc2 migration item prices", "operationId" : "list_pc2_migration_item_prices", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/limit", "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/offset", "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.\n", "maxLength" : 1000, "example" : null } }, { "name" : "pc2_migration_id", "in" : "query", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "description" : "pc2_migration reference key\n", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } }, "example" : null } }, { "name" : "pc2_migration_item_id", "in" : "query", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "description" : "item reference key\n", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null } }, "example" : null } }, { "name" : "is_invalid_pc1_id", "in" : "query", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "description" : "check if pc1 autocorrection required\n", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null } }, { "name" : "pc1_item_type", "in" : "query", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "is" : { "type" : "string", "description" : "\\* \\`plan\\` - PLAN \\* \\`addon\\` - ADDON\n", "enum" : [ "plan", "addon" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`plan\\` - PLAN \\* \\`addon\\` - ADDON\n", "enum" : [ "plan", "addon" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`plan\\` - PLAN \\* \\`addon\\` - ADDON\n", "enum" : [ "plan", "addon" ], "pattern" : "^\\[(plan|addon)(,(plan|addon))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`plan\\` - PLAN \\* \\`addon\\` - ADDON\n", "enum" : [ "plan", "addon" ], "pattern" : "^\\[(plan|addon)(,(plan|addon))*\\]$", "example" : null } }, "example" : null } }, { "name" : "is_recurring", "in" : "query", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "pc2_migration_item_price" : { "$ref" : "#/components/schemas/Pc2MigrationItemPrice", "description" : "Resource object representing pc2_migration_item_price" } }, "required" : [ "pc2_migration_item_price" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migration_item_prices/{pc2-migration-item-price-id}/delete" : { "post" : { "summary" : "Delete draft item price", "operationId" : "delete_draft_item_price", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-item-price-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-item-price-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "is_deleted" : { "type" : "boolean", "deprecated" : false, "example" : null } }, "required" : [ "is_deleted" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pc2_migration_item_prices/{pc2-migration-item-price-id}" : { "get" : { "summary" : "Retrieve a pc2 migration item price", "operationId" : "retrieve_a_pc2_migration_item_price", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-item-price-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-item-price-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration_item_price" : { "$ref" : "#/components/schemas/Pc2MigrationItemPrice", "description" : "Resource object representing pc2_migration_item_price" } }, "required" : [ "pc2_migration_item_price" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a pc2_migration_item_price", "operationId" : "update_a_pc2_migration_item_price", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "pc2-migration-item-price-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/pc2-migration-item-price-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "pc2_migration_item_id" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "metadata" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "sanitized_pc1_id" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "is_primary_attached_item" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "pc2_migration_item_price" : { "$ref" : "#/components/schemas/Pc2MigrationItemPrice", "description" : "Resource object representing pc2_migration_item_price" } }, "required" : [ "pc2_migration_item_price" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pricing_page_sessions/create_for_existing_subscription" : { "post" : { "summary" : "Create pricing page for existing subscription", "description" : "This endpoint streamlines the generation of a pricing page session to enable subscription [upgrade](https://www.chargebee.com/docs/2.0/proration.html#introduction_proration)\n, and [downgrade](https://www.chargebee.com/docs/2.0/proration.html#introduction_proration)\nworkflows using Chargebee's hosted pricing pages ([Atomic Pricing](https://www.atomicpricing.com/)\n). By providing a subscription ID as a parameter, you will obtain a hosted pricing page session URL. \nNote: [Full access key](https://www.chargebee.com/docs/api_keys.html#types-of-api-keys_full-access-key)\nauthentication is needed for this API request.\n", "operationId" : "create_pricing_page_for_existing_subscription", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "redirect_url" : { "type" : "string", "deprecated" : false, "description" : "The customers will be redirected to this URL upon successful checkout.\n", "maxLength" : 250, "example" : null }, "custom" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "JSON object of custom attributes (key-value pairs) used for pricing page targeting or content. \\[Configure\\](https://www.chargebee.com/docs/retention/settings-and-installation/chargebee-retention-field-mappings) custom attributes in the dashboard.\n", "example" : null }, "pricing_page" : { "type" : "object", "deprecated" : false, "description" : "Parameters for pricing page\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "The unique identifier of the pricing table for which the hosted page is created. See [documentation](https://www.chargebee.com/docs/growth/offers/customize-pricing-table#obtain-the-pricing-table-id) to obtain the pricing table id from Chargebee Growth. If you want the pricing table to be auto-selected based on your [Play configuration](https://www.chargebee.com/docs/growth/plays/plays-overview) in Chargebee Growth, do not pass this parameter. \nAction to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* cancel -Contract term completes and subscription is canceled.
\n* renew -action_at_term_end for the new contract term is set to renew.The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The amount on the invoice to which the discount is applied.
\n* invoice_amount -The discount is applied to the invoice sub_total.
Note:\nThis enum value is not supported for pricing_page_sessions resource, soon this value will be available for this resource. For more details please reach out to atomic-pricing@chargebee.com
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* one_time -The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The value of the discount. The format of this value depends on the kind of currency\nyou want to use for a discount. This is only applicable when type\nis fixed_amount\n.
The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period\n.
The unit of time for period.\nApplicable only when duration_type\nis limited_period\n.
A period of 24 hours.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
\n* week -A period of 7 days.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price\n.
Resource object representing pricing_page_session
" } }, "required" : [ "pricing_page_session" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/pricing_page_sessions/create_for_new_subscription" : { "post" : { "summary" : "Create pricing page for new subscription", "description" : "This endpoint streamlines the generation of a pricing page session to enable new subscription creation workflows using Chargebee's hosted pricing pages ([Atomic Pricing](https://www.atomicpricing.com/)\n). By providing a subscription ID and/or customer ID as a parameter, you'll obtain a pricing page session URL. \nNote: [Full access key](https://www.chargebee.com/docs/api_keys.html#types-of-api-keys_full-access-key)\nauthentication is needed for this API request.\n", "operationId" : "create_pricing_page_for_new_subscription", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "redirect_url" : { "type" : "string", "deprecated" : false, "description" : "The customers will be redirected to this URL upon successful checkout.\n", "maxLength" : 250, "example" : null }, "business_entity_id" : { "type" : "string", "deprecated" : false, "description" : "Sets the [context](/docs/api/business_entities) for this operation to the [business entity](/docs/api/business_entities) specified. Applicable only when multiple business entities have been created for the site. When this parameter is provided, new subscription and customer resources are created within the business entity.\n", "maxLength" : 50, "example" : null }, "auto_select_local_currency" : { "type" : "boolean", "default" : false, "deprecated" : false, "description" : "false: The first currency in the dropdown list is selected.true: Automatically determines the currency based on the visitor's geolocation. For example, if the visitor is from the United States and this flag is enabled, USD is selected as the currency-if it's available on the pricing page. Similarly, if the visitor is from India, INR is selected. If the visitor's country currency isn't available, the first currency in the dropdown list is selected.The unique ID of the customer for which this hosted_page\nshould be created. When not provided, a new customer is created with the ID set to the value provided for subscription[id].\nIf subscription[id]\nis unavailable, then the customer ID is autogenerated.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The amount on the invoice to which the discount is applied.
\n* invoice_amount -The discount is applied to the invoice sub_total.
Note:\nThis enum value is not supported for pricing_page_sessions resource, soon this value will be available for this resource. For more details please reach out to atomic-pricing@chargebee.com
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* one_time -The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The value of the discount. The format of this value depends on the kind of currency\nyou want to use for a discount. This is only applicable when type\nis fixed_amount\n.
The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period\n.
The unit of time for period.\nApplicable only when duration_type\nis limited_period\n.
A period of 24 hours.
\n* year -A period of 1 calendar year.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "example" : null }, "included_in_mrr" : { "type" : "array", "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\nis specific_item_price\n.
Resource object representing pricing_page_session
" } }, "required" : [ "pricing_page_session" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/site_pc_meta_records" : { "get" : { "summary" : "List site pc meta records", "operationId" : "list_site_pc_meta_records", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/limit", "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/offset", "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.\n", "maxLength" : 1000, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "items" : { "type" : "object", "properties" : { "site_pc_meta_record" : { "$ref" : "#/components/schemas/SitePcMetaRecord", "description" : "Resource object representing site_pc_meta_record" } }, "required" : [ "site_pc_meta_record" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.", "maxLength" : 1000, "example" : null } }, "required" : [ "list" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/omnichannel_subscriptions/{omnichannel-subscription-id}/move" : { "post" : { "summary" : "Move an Omnichannel subscription", "description" : "Moves an omnichannel_subscription\nto another customer. Updates the Omnichannel subscription's customer ID and related records, then triggers the OMNICHANNEL_SUBSCRIPTION_MOVED_IN\nwebhook with the new customer details.
Specifies the unique ID of the customer\nresource to which the subscription will be moved.
Resource object representing Omnichannel subscription
" } }, "required" : [ "omnichannel_subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/omnichannel_subscriptions/{omnichannel-subscription-id}" : { "get" : { "summary" : "Retrieve an Omnichannel subscription", "description" : "Retrieves an omnichannel_subscription object using an omnichannel_subscription_id. You can get the omnichannel_subscription_id for any successfully recorded purchase in Chargebee using List Omnichannel subscriptions API.
Resource object representing Omnichannel subscription
" } }, "required" : [ "omnichannel_subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/omnichannel_subscriptions/{omnichannel-subscription-id}/omnichannel_transactions" : { "get" : { "summary" : "List Omnichannel transactions of an Omnichannel subscription", "description" : "Returns a list of omnichannel_transaction\nassociated with the specified omnichannel_subscription\n.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Returns a list of omnichannel_subscription\n.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Status of the omnichannel_subscription_item.\nLearn more\nabout status and their mapping with the store's status.
Product ID in the source.
Returns a list of omnichannel_subscription_item_scheduled_change\nassociated with the specified omnichannel_subscription_item\n.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
The Retrieve a Recorded Purchase API retrieves a recorded_purchase object using the recorded_purchase.id returned in the response of the Record a Purchase API. You can use this API to check if the purchase was successfully recorded in Chargebee and to obtain the omnichannel_transaction_id and omnichannel_subscription_id associated with the successfully recorded purchase.
Resource object representing Recorded purchase
" } }, "required" : [ "recorded_purchase" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/recorded_purchases" : { "post" : { "summary" : "Record a purchase", "description" : "The Record a Purchase API allows you to record in-app purchases made through channels such as the Apple App Store and Google Play Store in Chargebee. When you invoke this API, it initiates a purchase recording job and returns the recorded_purchase resource in the response. As part of the job, the API verifies the provided source specific request payload like transaction_id for Apple App Store or purchase_token for Google Play Store with the source such as apple_app_store or google_play_store respectively. If the verification is successful, the corresponding purchase is recorded in Chargebee. Upon completion, the recorded_purchase resource will include the relevant omnichannel_transaction_id and omnichannel_subscription_id.\nSince this operation is asynchronous, you need to check the status attribute of the recorded_purchase resource to track the job status: in_process, completed, or failed.\nNote: Upon successful completion of this asynchronous operation, Chargebee triggers the omnichannel_subscription_created event.\nIf the recorded_purchase status is failed, review the error_detail attribute and take corrective action to re-record the purchase.\nYou can use this API to record new and older purchases made on Apple App Store or Google Play Store by passing the transaction_id or purchase_token respectively received during the subscription purchase. You can record purchases for subscriptions that are in Active or Expired status.
App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
The id\nof the customer\nobject that is associated with this purchase. If the customer_id\nis not present in Chargebee when the record_a_purchase\nAPI request is made, the API will return an error. Use create_a_customer\nAPI to create a customer.
The source specific request payload that will be used to record the purchase. Provide parameters as apple_app_store[]
The transaction_id\nreceived from Apple App Store during a new subscription purchase or the re-purchase of an expired\nsubscription.
The receipt\nfrom which transaction_id\nis fetched and recorded
The product_id\nfor which the purchase has to be recorded
Parameters for google_play_store
The purchase_token\nreceived from the Google Play Store either from the Android device during a new subscription purchase or from the Google Play Console. You can record purchase tokens using this API if the subscription state in Google is SUBSCRIPTION_STATE_ACTIVE\n.
InApp product_id\non the google_play_store\nfor which the purchase has to be recorded. This is applicable only when recording google one time orders.
The order_id\nreceived from the Google Play Store either from the Android device during a purchase or from the Google Play Console. It is recommended to use the order_id\ninstead of purchase_token\n.
Parameters for omnichannel_subscriptions
Specifies the id\nto assign as the omnichannel subscription identifier for this purchase. If not provided, Chargebee automatically generates an ID.
Resource object representing Recorded purchase
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" } }, "required" : [ "customer", "recorded_purchase" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/omnichannel_one_time_orders" : { "get" : { "summary" : "List Omnichannel one time orders", "description" : "Retrieves a list of omnichannel_one_time_orders\nobjects.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Retrieves an omnichannel_one_time_order object using its omnichannel_one_time_order_id. You can obtain the omnichannel_one_time_order_id for any successfully recorded purchase in Chargebee by using the List Omnichannel One-Time Orders API.
Resource object representing omnichannel_one_time_order
" } }, "required" : [ "omnichannel_one_time_order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/rules/{rule-id}" : { "get" : { "summary" : "Retrieve rule data", "operationId" : "retrieve_rule_data", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "rule-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/rule-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "rule" : { "$ref" : "#/components/schemas/Rule", "description" : "Resource object representing rule" } }, "required" : [ "rule" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/usage_events" : { "post" : { "summary" : "Ingest a usage event", "description" : "This endpoint ingests a usage event into Chargebee. \n**Note**\n: - A single event can be of **1 KB** in size.\n\n* **Limit** : **10,000** events per minute.\n", "operationId" : "create_a_usage_event", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "deduplication_id" : { "type" : "string", "deprecated" : false, "description" : "An identifier used by the Chargebee's customer to distinguish between multiple events generated at the same timestamp for a single subscription_id.\nThe combination of usage_timestamp, subscription_id, and deduplication_id uniquely identifies each event.
Example:\nIf 3 events are generated for subscription_id = sub-1 at 2025-04-01T00:00:00.000Z, each event must have a distinct deduplication_id.
The unique identifier of a subscription.
\nNote:
subscription_id is provided, usage data is recorded against it.subscription_id can be used, and the subscription can be imported later, once the usage is successfully recorded.subscription_id will be applied to the invoice.The timestamp indicating when this usage occurred, represented as Epoch\ntime in milliseconds\n.\nExample: 1738732394123\nrepresents the timestamp for February 5, 2025, at 05:13:14.123 UTC.
Note:\nThe timestamp must be within the last 12 hours\n.
A schema-less field that accepts any JSON-formatted data to define the attributes of the ingested event. It is a requirement to structure the data in a flat format wherever possible for better compatibility with downstream processing.\nWe strongly encourage using unique field names-particularly for fields intended for metering purposes. This approach enhances clarity and maintainability in the future.\nFor example, a field named status,
Can represent string values such as accepted or processing in one context.
In another scenario, it might hold numeric values, such as HTTP response codes like 200, 300, or 400.
Note:
Resource object representing usage_event
" } }, "required" : [ "usage_event" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ], "servers" : [ { "url" : "{protocol}://{site}.ingest.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } }, { "url" : "{protocol}://{site}-test.ingest.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } } ] } }, "/batch/usage_events" : { "post" : { "summary" : "Ingest usage events in batch", "description" : "This endpoint ingests a batch of usage events into Chargebee. \n**Note**\n: - You can ingest **500** events in a batch ingestion, each **1 KB** in size. This means a single API request will efficiently handle **500 KB** of data.\n\n* **Limit** : **10,000** events per minute.\n", "operationId" : "ingest_usages_in_batch", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "events" : { "type" : "object", "deprecated" : false, "description" : "Parameters for batch usage events\n", "properties" : { "deduplication_id" : { "type" : "array", "description" : "An identifier used by the Chargebee's customer to distinguish between multiple events generated at the same timestamp for a single subscription_id.\nThe combination of usage_timestamp, subscription_id, and deduplication_id uniquely identifies each event.
Example:\nIf 3 events are generated for subscription_id = sub-1 at 2025-04-01T00:00:00.000Z, each event must have a distinct deduplication_id.
The unique identifier of a subscription.
\nNote:
subscription_id is provided, usage data is recorded against it.subscription_id can be used, and the subscription can be imported later, once the usage is successfully recorded.subscription_id will be applied to the invoice.The timestamp indicating when this usage occurred, represented as Epoch\ntime in milliseconds\n.\nExample: 1738732394123\nrepresents the timestamp for February 5, 2025, at 05:13:14.123 UTC.
Note:\nThe timestamp must be within the last 12 hours\n.
A schema-less field that accepts any JSON-formatted data to define the attributes of the ingested event. It is a requirement to structure the data in a flat format wherever possible for better compatibility with downstream processing.\nWe strongly encourage using unique field names-particularly for fields intended for metering purposes. This approach enhances clarity and maintainability in the future.\nFor example, a field named status,
Can represent string values such as accepted or processing in one context.
In another scenario, it might hold numeric values, such as HTTP response codes like 200, 300, or 400.
Note:
The unique identifier for the batch of usage events processed.
", "x-cb-attribute-pcv" : 2, "maxLength" : 36, "example" : null }, "failed_events" : { "type" : "array", "deprecated" : false, "description" : "A detailed list of events that failed during the batch ingestion process.
", "items" : { "example" : null }, "example" : null } }, "required" : [ "batch_id", "failed_events" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ], "servers" : [ { "url" : "{protocol}://{site}.ingest.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } }, { "url" : "{protocol}://{site}-test.ingest.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } } ] } }, "/usage_files/{usage-file-id}/processing_status" : { "get" : { "summary" : "Retrieve file processing status", "description" : "Use this endpoint to get the current status and details of a usage events file.\n", "operationId" : "get_uploaded_file_processing_status", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "usage-file-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/usage-file-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "usage_file" : { "$ref" : "#/components/schemas/UsageFile", "description" : "Resource object representing usage_file
" } }, "required" : [ "usage_file" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ], "servers" : [ { "url" : "{protocol}://{site}.file-ingest.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } }, { "url" : "{protocol}://{site}-test.file-ingest.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } } ] } }, "/usage_files/upload_url" : { "post" : { "summary" : "Retrieve usage file upload URL", "description" : "This endpoint returns an upload URL for uploading usage events files, allowing you to upload files in supported formats. The file is processed asynchronously, and its status can be tracked using the retrieve_file_processing_status endpoint.
Before uploading, review the following guidelines and constraints:
Name of the file being uploaded.
\nNote:\nNo special characters are allowed in the file_name\nexcept for underscores _\nand hyphens -\n.Example:
| Valid file name | Invalid file name |
| merchant_data.csv | merchant@data.csv |
| sales_report-2024.csv | sales&report-2024.csv |
| customer_details_file.csv | customer!details#file.csv |
Indicates the format of a file.
\nNote:\nCurrently, only text/csv\nis supported.
Resource object representing usage_file
" } }, "required" : [ "usage_file" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ], "servers" : [ { "url" : "{protocol}://{site}.file-ingest.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } }, { "url" : "{protocol}://{site}-test.file-ingest.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } } ] } }, "/personalized_offers" : { "post" : { "summary" : "List personalized offers", "description" : "This API is used to retrieve a list of personalized offer(s) for a customer based on the context (such as customer or subscription details and end-user attributes). This allows you to retrieve any active offers targeted to the user.\nYou can pre-call this API as soon as you have the user context at the point of login, or can call this API at any other point in the user journey when an offer is to be shown.\n\nSystem evaluates eligibility and mapping to the right offer based on:\n\n* Customer profile and subscription information.\n* Device and browsing context.\n* Custom fields.\n* Play configurations.\n\n**Note**\n\n* Although the response is modeled as a list, the API currently returns at most one personalized offer (the best-matched offer for the user).\n* If no offers are available, the list will be empty. No error is thrown in this case; an empty result is a valid response.\n\n**Features of this API**\n\nThe List Personalized Offers endpoint allows you to:\n\n* Retrieve context-aware offers targeted to customers or end users.\n* Leverage multiple signals (profile, subscription, device/browser context, custom fields, and plays).\n* Call flexibly at login, checkout, renewal, or any point in the user journey.Handle gracefully when no offers are available (returns an empty list, not an error).\n* Support both B2C (single user per customer) and B2B (multiple end users per customer) scenarios.\n", "operationId" : "list_personalized_offers", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "first_name" : { "type" : "string", "deprecated" : false, "description" : "First name of the customer. \n**Note**\nThis parameter is ignored if it is not mapped to any field in the [settings](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention).\n", "maxLength" : 150, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "Last name of the customer. \n**Note**\nThis parameter is ignored if it is not mapped to any field in the [settings](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention).\n", "maxLength" : 150, "example" : null }, "email" : { "type" : "string", "format" : "email", "deprecated" : false, "description" : "Customer's email address. \n**Note**\nThis parameter is ignored if it is not mapped to any field in the [settings](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention).\n", "maxLength" : 70, "example" : null }, "roles" : { "type" : "array", "deprecated" : false, "description" : "Roles or user types associated with the end user. (Useful in offer targeting for B2B scenarios with multiple user roles.). \n**Note**\nThis parameter is ignored if it is not mapped to any field in the [settings](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention).\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "example" : null }, "external_user_id" : { "type" : "string", "deprecated" : false, "description" : "The unique identifier of the user in the your system. This is used to identify the user for whom the offer is being created. \n**Note**\nThis parameter is ignored if it is not mapped to any field in the [settings](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention).\n", "maxLength" : 50, "example" : null }, "subscription_id" : { "type" : "string", "deprecated" : false, "description" : "The unique identifier of the subscription for which the offer should be retrieved.\n**Notes:**\n\n* **Required** if multiple brands are configured in your Growth application.\n* **Recommended** to always provide.\n* If omitted and the customer has multiple subscriptions, the system attempts to retrieve the offer associated with one of their subscriptions.\n", "maxLength" : 50, "example" : null }, "customer_id" : { "type" : "string", "deprecated" : false, "description" : "The ID of the customer in the billing system (Chargebee customer ID).\n", "maxLength" : 50, "example" : null }, "custom" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "JSON object of custom attributes (key-value pairs) used for offer targeting or content. \\[Configure\\](https://www.chargebee.com/docs/retention/settings-and-installation/chargebee-retention-field-mappings) custom attributes in the dashboard. \\*\\*Note\\*\\* This parameter is ignored if it is not mapped to any field in the \\[settings\\](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention).\n", "example" : null }, "request_context" : { "type" : "object", "deprecated" : false, "description" : "A JSON object with standard context attributes (browser, device, locale, etc.) of the end user's session. This can help in offer targeting based on user environment.\n", "properties" : { "user_agent" : { "type" : "string", "deprecated" : false, "description" : "The user's browser or device user agent string. Helps determine browser and platform details.\nFor example, chrome/7.10\n", "maxLength" : 255, "example" : null }, "locale" : { "type" : "string", "deprecated" : false, "description" : "The user's locale setting (e.g., en-US, fr-FR). Useful for regional offer targeting.\n", "maxLength" : 50, "example" : null }, "timezone" : { "type" : "string", "deprecated" : false, "description" : "The user's timezone identifier (e.g., America/New_York). Used for contextual targeting based on time.\n", "maxLength" : 64, "example" : null }, "url" : { "type" : "string", "deprecated" : false, "description" : "The current page URL where the offer is being displayed. Useful for context-sensitive offers.\n", "maxLength" : 250, "example" : null }, "referrer_url" : { "type" : "string", "deprecated" : false, "description" : "The referring page URL, i.e., the previous page that navigated the user to the current one. Can help with attribution analysis.\n", "maxLength" : 250, "example" : null } }, "example" : null } }, "required" : [ "customer_id" ], "example" : null }, "encoding" : { "request_context" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "personalized_offers" : { "type" : "array", "description" : "List of best offers to be shown to the customer. Currently this will always return one personalized offer. This will be empty if no best offers are found.
", "items" : { "$ref" : "#/components/schemas/PersonalizedOffer", "description" : "Resource object representing personalized_offer" }, "example" : null }, "brand" : { "$ref" : "#/components/schemas/Brand", "description" : "Resource object representing brand
" }, "expires_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The timestamp until which the offer remains active. After this time, you must retrieve the offer again via the List Personalised Offers API to get the latest.
", "example" : null } }, "required" : [ "expires_at", "personalized_offers" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ], "servers" : [ { "url" : "{protocol}://{site}.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } }, { "url" : "{protocol}://{site}-test.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } } ] } }, "/offer_fulfillments" : { "post" : { "summary" : "Create an offer fulfillment", "description" : "This API notifies that a user has accepted an offer, logs an accepted event immediately for reporting, and triggers a backend processing depending on the offer's processing_type.\nYou can call this API when a user accepts an offer (e.g., the user clicked Accept Offer or a similar confirmation).\nThis API will record an accepted event as soon as the API is called and initiate the appropriate fulfillment mechanism according to processing_type:
billing_update: Initiates subscription or billing record updates (e.g., applying a discount or changing a plan) asynchronously.checkout: Returns a hosted_page object in the response, which contains a URL to render the hosted checkout flow.url_redirect: Returns a redirect_url. You are responsible for managing fulfillment on your end and must call the Update Offer Fulfillment API to report either completion or failure.webhook: Sends a webhook, and you must also manage fulfillment on your end. Be sure to call the Update Offer Fulfillment API to report completion or failure.email: Sends an email containing the offer details as configured. You are responsible for handling fulfillment on your side and must call the Update Offer Fulfillment API to report completion or failure.\nYou can poll the Retrieve Offer Fulfillment endpoint for final status on billing_update and checkout flows.\nUpon actual fulfillment completion, the system logs a fulfilled event and sends notifications (webhook, Slack, email, Segment) as configured.Represents the fulfillment created for the offer.
" }, "hosted_page" : { "$ref" : "#/components/schemas/HostedPage", "description" : "Represents the hosted page created for the offer. This is returned only if the selected offer option's processing_type\nis checkout.
Represents the fulfillment created for the offer.
" } }, "required" : [ "offer_fulfillment" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ], "servers" : [ { "url" : "{protocol}://{site}.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } }, { "url" : "{protocol}://{site}-test.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } } ] }, "post" : { "summary" : "Update an offer fulfillment", "description" : "This API is used to update the status of offer fulfillment for the processing types url_redirect, webhook and email as Chargebee cannot automatically fulfill these offers.\nIf status = failed, you must include a failure_reason to explain why the fulfillment did not succeed. The system logs a fulfilled event when status = completed or a failed event when status = failed.\nNote: If the offer fulfillment is not marked as completed or failed within 7 days, Chargebee will mark the offer fulfillment as failed with the error code as external_fulfillment_failed.
Explanation for failure; required when status\n= failed\n.
Represents the fulfillment created for the offer.
" } }, "required" : [ "offer_fulfillment" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ], "servers" : [ { "url" : "{protocol}://{site}.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } }, { "url" : "{protocol}://{site}-test.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } } ] } }, "/offer_events" : { "post" : { "summary" : "Create an offer event", "description" : "The Create Offer Event API records user interactions with an offer for tracking and analytics purposes.\nUse this API to log user-triggered engagement events such as:
viewed - when an offer is displayed to the user.dismissed - when the user closes or ignores the offer.\nThese events are essential for accurate offer performance reporting and funnel analysis. Make sure to send them as they happen.Note: System-driven events like accepted and fulfilled are captured automatically by the growth system through fulfillment workflows. You do not need to post these.
The webhook_endpoint\nresource object that contains the configuration and details of the created webhook.
The webhook_endpoint\nresource object that contains the configuration and details of the created webhook.
The target URL where webhook notifications will be sent.
\nNote\nOnly URL ports 80, 443, 8080, or 8443 are allowed.
Indicates whether the webhook endpoint is disabled. Set to true\nto disable the endpoint, set to false\nto enable the endpoint.
The webhook_endpoint\nresource object that contains the configuration and details of the created webhook.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
The target URL where webhook notifications will be sent.
\nNote\nOnly URL ports 80, 443, 8080, or 8443 are allowed.
Indicates whether the webhook endpoint is disabled. Set to true\nto disable the endpoint, set to false\nto enable the endpoint.
Indicates the response schema used in the webhook payload, based on the product catalog version configured for the site.
\nNote\nThis field is only applicable if the site is in compat mode.
The webhook payload uses a schema compatible with both Product Catalog 1.0 and 2.0. This is applicable only to sites automatically upgraded to Product Catalog 2.0.
\n* items -The webhook payload follows the Product Catalog 2.0\nschema and uses the Items API model\n.
\n* plans_addons -The webhook payload follows the Product Catalog 1.0\nschema and uses the Plans\nand Addons\nmodel.
", "enum" : [ "plans_addons", "items", "compat" ], "example" : null }, "enabled_events" : { "type" : "array", "deprecated" : false, "description" : "A list of event types that trigger this webhook. \n**Note**\nIf this field is left empty, the webhook will enable [all event types](/docs/api/webhook_endpoints) by default.\n", "items" : { "type" : "string", "deprecated" : false, "enum" : [ "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "payment_schedules_created", "payment_schedules_updated", "payment_schedule_scheme_created", "payment_schedule_scheme_deleted", "subscription_renewal_reminder", "add_usages_reminder", "payment_due_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "item_family_created", "item_family_updated", "item_family_deleted", "item_created", "item_updated", "item_deleted", "item_price_created", "item_price_updated", "item_price_deleted", "attached_item_created", "attached_item_updated", "attached_item_deleted", "differential_price_created", "differential_price_updated", "differential_price_deleted", "feature_created", "feature_updated", "feature_deleted", "feature_activated", "feature_reactivated", "feature_archived", "item_entitlements_updated", "entitlement_overrides_updated", "entitlement_overrides_removed", "item_entitlements_removed", "entitlement_overrides_auto_removed", "subscription_entitlements_created", "subscription_entitlements_updated", "business_entity_created", "business_entity_updated", "business_entity_deleted", "customer_business_entity_changed", "subscription_business_entity_changed", "purchase_created", "voucher_created", "voucher_expired", "voucher_create_failed", "item_price_entitlements_updated", "item_price_entitlements_removed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "price_variant_created", "price_variant_updated", "price_variant_deleted", "customer_entitlements_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "usage_file_ingested", "omnichannel_subscription_item_pause_scheduled", "omnichannel_subscription_moved_in", "omnichannel_transaction_created", "alert_status_changed", "omnichannel_subscription_item_updated", "omnichannel_subscription_item_recovered" ], "example" : null }, "example" : null } }, "required" : [ "name", "url" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "webhook_endpoint" : { "$ref" : "#/components/schemas/WebhookEndpoint", "description" : "The webhook_endpoint\nresource object that contains the configuration and details of the created webhook.
Retrieves aggregated usage data for a metered feature in a subscription over a specified reporting window.
Unlike Retrieve Current Usage Charges for a Subscription API, which returns the current unbilled usage snapshot including charges, this endpoint returns aggregated usage for a requested timeframe.
Use this endpoint to power experiences such as:
Returns usage summary entries for the requested feature within the specified timeframe.
If timeframe_start and timeframe_end are not provided, the reporting range defaults to the start of the subscription's current term for timeframe_start and the current time for timeframe_end.
window_size is omitted, the response returns a single aggregate for the full reporting range.window_size is provided, the response returns one aggregated entry for each window in the reporting range.Aggregation windows begin at timeframe_start and continue consecutively until timeframe_end.
The usages in the window will be bucketed into rolling windows aligned to timeframe_start, not to calendar boundaries.
If:
timeframe_start is May 10 10:00:00 UTCtimeframe_end is June 10 10:00:00 UTCwindow_size is dayThe response returns windows such as:
May 10 10:00:00 UTC → May 11 10:00:00 UTCMay 11 10:00:00 UTC → May 12 10:00:00 UTCand continues in the same pattern until the final window:
June 9 10:00:00 UTC → June 10 10:00:00 UTCIf you need calendar-aligned reporting, set timeframe_start to the required boundary. For example, use 00:00:00 UTC for daily reporting aligned to calendar days, or the first day of the month at 00:00:00 UTC for monthly reporting aligned to calendar months.
Each aggregation window follows inclusive-exclusive semantics:
aggregated_from is inclusiveaggregated_till is exclusiveIn other words, each window is represented as aggregated_from and aggregated_till.
This means:
aggregated_from is included in that windowaggregated_till is excluded from that window and counted in the next window, if one existstimeframe_end is excludedThese inclusive-exclusive boundaries ensure that windows do not overlap and that events on boundaries are never double-counted.
If a feature uses distinct-count aggregation, the distinct count is evaluated separately within each returned window.
This means the same entity can be counted once in multiple windows if it appears in each of them.
If the same user appears in both:
That user is counted once in the Jan 1 aggregate and once in the Jan 2 aggregate.
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly,\nalways set offset to the value of next_offset obtained in the previous iteration of the API call.
Returns the current, unbilled usage charges for the metered features on a subscription.
This endpoint returns usage for each feature’s current usage period. If entitlement or pricing changes during that period, the same feature can appear multiple times, with one usage_charge object returned for each interval.
Use this endpoint to present the below information in your portal or customer-facing experiences.
This endpoint does not return historical, billed, or invoice-backed usage.
This endpoint returns usage for the active usage window of each feature, not necessarily for the full subscription term.
To read the response correctly, keep these three concepts in mind:
The subscription current term is the broader billing term of the subscription. It is usually determined by the lowest-frequency item on the subscription, typically the plan.
It is included as context only.
This endpoint does not return usage for the full subscription term unless that also happens to be the feature’s active usage window.
The current usage period is the time range in which usage is actively accruing and has not yet been billed for a feature.
This is the primary time window used by the API.
How it is determined
Feature with metered addon - The current usage period is the overage addon’s billing period.
Feature without metered addon - The current usage period is the currently active entitlement window for that feature.
A current usage period may be returned as a single interval or as multiple intervals.
A usage interval is a continuous segment where the feature’s entitlement and pricing remain unchanged.
If nothing changes during the period, the API returns one entry for that feature.
If something changes, the API returns multiple entries for the same feature.
Current Usage Period: 1 Jan 00:00:00 – 31 Jan 23:59:59
This interval reflects the subscription’s state before the addon was active.
This interval begins the moment the entitlement context changes and ends at the response snapshot (20 Jan).
usage_to date is capped at the snapshot date (Jan 20).The API returns separate usage charge objects for each interval where entitlement remains stable.
First object - Initial Plan Period
\nCovers the storage feature from 1 Jan 00:00:00 to 16 Jan 08:59:59.
\nDuring this interval, total entitlement is 100 GB.
\n80 GB is consumed, so 20 GB remains and carries forward into the next interval.
\nSecond object - Post-Addon Addition
\n"list": [\n "usage_charge": {\n "subscription_id":"sub-001",\n "feature_id": "storage_abc",\n “usage_from”:"1 Jan 00:00:00", // For readability, the exact dates are shown here; the actual response will have timestamps.\n “usage_to”:"16 Jan 08:59:59",\n "included_usage": "100",\n "total_usage": "80",\n "on_demand_usage": "0", \n "amount": "0",\n "metered_item_price_id":"storage_001"\n },\n "usage_charge": {\n "subscription_id":"sub-001",\n "feature_id": "storage_abc",\n “usage_from”:"16 Jan 09:00:00",\n “usage_to”:"20 Jan 23:59:59",\n "included_usage": "220",\n "total_usage": "100",\n "on_demand_usage": "0", \n "amount": "0",\n "metered_item_price_id":"storage_001"\n }\n ]\nNote: For readability, the example above uses dates such as 1 Jan and 16 Jan. In the actual API response, usage_from and usage_to are returned as timestamps.
When processing the response:
feature_idusage_fromamount only when presentDetermines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset\nto the value of next_offset\nobtained in the previous iteration of the API call.
Returns the effective set of alert configurations for a given subscription. This includes global alerts (filtered by the subscription's plan) and any subscription-scoped alerts, giving you a single view of all threshold rules in force.
Use this endpoint when building subscription dashboards or evaluating which alerts apply to a specific customer.
Note: This endpoint returns alert configurations only. To check the runtime state (whether alerts are currently within_limit or in_alarm), use List alert statuses for a subscription.
optional, string
\nPagination cursor returned by a previous list call. Use the next_offset value from the previous response.
An array of alert objects matching the filter criteria.
", "items" : { "type" : "object", "properties" : { "alert" : { "$ref" : "#/components/schemas/Alert", "description" : "Resource object representing alert" } }, "required" : [ "alert" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "Returned only if more results are available. Pass this value as offset in the next request to fetch the next page.
Retrieves a single alert configuration by alert_id. This returns the rule definition only and does not include runtime evaluation state.
Note: To check whether a subscription is currently within_limit or in_alarm for this alert, use Retrieve alert status.
Resource object representing alert.
" } }, "required" : [ "alert" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update an alert", "description" : "Updates an existing alert configuration. Use this to change the threshold values or toggle the status between enabled and disabled.
Alert status on threshold change
When the threshold is updated for an alert, the alarm_status for all impacted subscriptions is reset to within_limit. The alert is only re-evaluated when new usage events are ingested for the associated metered feature.
Alert status on disable
When the alert status is changed to disabled, all further evaluation stops. No webhooks are fired for this alert while it is disabled. When the alert is re-enabled, the alarm_status is set to within_limit and is only re-evaluated upon new usage event ingestion.
Set to enabled to activate the alert or disabled to deactivate it.
The alert is active and will trigger when the threshold is breached.
\n* disabled -The alert is inactive and will not trigger, regardless of usage.
", "enum" : [ "enabled", "disabled" ], "example" : null }, "threshold" : { "type" : "object", "deprecated" : false, "description" : "The threshold configuration that defines when this alert fires. Only the fields provided are updated.\n", "properties" : { "mode" : { "type" : "string", "deprecated" : false, "description" : "How the threshold value is interpreted.
The threshold value represents a percentage of the plan quota (0–100).
The threshold value represents an absolute usage quantity.
The numeric threshold at which the alert fires. For percentage mode, this must be between 0 and 100 inclusive. For absolute mode, this must be >= 0.
Resource object representing alert.
" } }, "required" : [ "alert" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/alerts/{alert-id}/delete" : { "post" : { "summary" : "Delete an alert", "description" : "Deletes an alert configuration. Only subscription-scoped alerts can be deleted using this endpoint.
Important
This operation cannot delete global alerts. To stop a global alert from firing, update the alert and set status to disabled instead.
Alert configuration
The alert configuration is permanently deleted from the system and cannot be recovered.
Alert statuses
All alert statuses associated with this alert are removed. No further evaluation takes place, and no alert_status_changed webhooks are fired for this alert going forward.
Resource object representing alert.
" } }, "required" : [ "alert" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/alerts" : { "get" : { "summary" : "List alerts", "description" : "Returns a list of alert configurations meeting **all** the conditions specified in the filter parameters below. Results include both global and subscription-scoped alerts. \n**Note:** To retrieve only the alerts that are in effect for a specific subscription (after resolving global rules and overrides), use [List applicable alerts](/docs/api/alerts/list-applicable-alerts) instead.\n", "operationId" : "list_alerts", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-business-entity-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.\n", "maxLength" : 50, "example" : null } }, { "name" : "limit", "in" : "query", "description" : "optional, integer\n\nMaximum number of results to return.\n\n**Example →**\n*limit = 10*\n", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "optional, string
\nPagination cursor returned by a previous list call. Use the next_offset value from the previous response.
Example →\noffset = "MjAyNC0xMi0yMFQxMjozMjo1MSswMDowMHw5OTk5OTk5OTk="
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.\n", "maxLength" : 1000, "example" : null } }, { "name" : "id", "in" : "query", "description" : "optional, string filter\n\nFilter alerts by [id](/docs/api/alerts/alert-object#id).\n\n**Example →**\n*id\\[in\\] = \"alert___dev__3Nl7purV3LwbKYH\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } }, "example" : null } }, { "name" : "type", "in" : "query", "description" : "optional, enumerated string filter\n\nFilter by [type](/docs/api/alerts/alert-object#type).\n\n**Example →**\n*type\\[is\\] = \"usage_exceeded\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "is" : { "type" : "string", "description" : "\\* \\`usage_exceeded\\` - usage_exceeded\n", "enum" : [ "usage_exceeded" ], "example" : null } }, "example" : null } }, { "name" : "subscription_id", "in" : "query", "description" : "optional, string filter\n\nFilter by [subscription_id](/docs/api/alerts/alert-object#subscription_id) to find alerts scoped to a specific subscription.\n\n**Example →**\n*subscription_id\\[is\\] = \"sub_KyV2S7Qm8tL7p\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null } }, "example" : null } }, { "name" : "status", "in" : "query", "description" : "optional, enumerated string filter\n\nFilter by [status](/docs/api/alerts/alert-object#status).\n\n**Example →**\n*status\\[is\\] = \"enabled\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "properties" : { "is" : { "type" : "string", "description" : "\\* \\`enabled\\` - enabled \\* \\`disabled\\` - disabled\n", "enum" : [ "enabled", "disabled" ], "example" : null } }, "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "list" : { "type" : "array", "description" : "An array of alert objects matching the filter criteria.
", "items" : { "type" : "object", "properties" : { "alert" : { "$ref" : "#/components/schemas/Alert", "description" : "Resource object representing alert" } }, "required" : [ "alert" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "Returned only if more results are available. Pass this value as offset in the next request to fetch the next page.
Creates a new alert configuration for a metered feature. The alert can be global or subscription-scoped depending on whether subscription_id is provided.
Note: Creating an alert defines the threshold rule only. After an alert is created, Chargebee begins evaluating it as new usage events are ingested for the associated metered feature. Alert statuses are created and updated during Alert evaluation. The runtime evaluation state for each subscription is available via the Alert Status endpoints.
metered_feature_id must reference an existing metered feature configured on your site.type must be usage_exceeded.filter_conditions, only plan_price_id is supported as the field, with operator equals or not_equals.The type of alert to create. Currently only usage_exceeded is supported.
The alert fires when usage of the metered feature exceeds the configured threshold.
", "enum" : [ "usage_exceeded" ], "example" : null }, "name" : { "type" : "string", "deprecated" : false, "description" : "A human-readable name for the alert. Maximum 50 characters.\n", "maxLength" : 50, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "An optional description providing additional context about the alert. Maximum 65,000 characters.\n", "maxLength" : 65000, "example" : null }, "metered_feature_id" : { "type" : "string", "deprecated" : false, "description" : "The identifier of the [metered feature](/docs/api/usages) that this alert should monitor.\n", "maxLength" : 50, "example" : null }, "subscription_id" : { "type" : "string", "deprecated" : false, "description" : "The identifier of the subscription to scope this alert to. If omitted, the alert is created as a global alert. If provided, filter_conditions must not be set.
How the threshold value is interpreted.
The threshold value represents a percentage of the plan quota (0–100).
The threshold value represents an absolute usage quantity.
The numeric threshold at which the alert fires. For percentage mode, this must be between 0 and 100 inclusive. For absolute mode, this must be >= 0.
An array of conditions that restrict which subscriptions a global alert applies to. Multiple conditions are evaluated with OR logic. Cannot be set when subscription_id is provided.
The subscription attribute to filter on. Currently only plan_price_id is supported.
Filters by the plan price associated with the subscription.
", "enum" : [ "plan_price_id" ], "example" : null }, "example" : null }, "operator" : { "type" : "array", "items" : { "type" : "string", "deprecated" : false, "description" : "The comparison operator for the filter condition.
\n* not_equals -The subscription attribute must not equal the specified value.
The subscription attribute must equal the specified value.
Resource object representing alert.
" } }, "required" : [ "alert" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/alert_statuses" : { "get" : { "summary" : "List alert statuses for a subscription", "description" : "Returns the runtime state of all alerts for a given subscription. Each entry in the response indicates whether the subscription is within_limit or in_alarm for a specific alert.
Use this endpoint to build a subscription-level dashboard showing which thresholds have been breached and when.
Note: This endpoint returns runtime state, not alert configurations. To retrieve the alert rules that apply to a subscription, use List applicable alerts.
optional, string
\nPagination cursor returned by a previous list call. Use the next_offset value from the previous response.
An array of alert status objects, one per impacted subscription.
", "items" : { "type" : "object", "properties" : { "alert_status" : { "$ref" : "#/components/schemas/AlertStatus", "description" : "Resource object representing alert_status" } }, "required" : [ "alert_status" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "Returned only if more results are available. Pass this value as offset in the next request to fetch the next page.
Returns the runtime state of a specific alert across all impacted subscriptions. Each entry indicates whether a subscription is within_limit or in_alarm for the given alert.
Use this endpoint to monitor which subscriptions are currently breaching a threshold, for example when building internal dashboards or CSM workflows.
alert_id must reference a global alert. Subscription-scoped alerts return a 400 error since they apply to only one subscription — use Retrieve alert status instead.optional, string
\nPagination cursor returned by a previous list call. Use the next_offset value from the previous response.
An array of alert status objects, one per impacted subscription.
", "items" : { "type" : "object", "properties" : { "alert_status" : { "$ref" : "#/components/schemas/AlertStatus", "description" : "Resource object representing alert_status" } }, "required" : [ "alert_status" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "Returned only if more results are available. Pass this value as offset in the next request to fetch the next page.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The invoice for a subscription in Chargebee is generated at the time of subscription renewal. Invoices can also be generated in advance for an upcoming renewal or set of renewals. With Advance Invoicing Schedules, you can set up a plan for when such advance invoices are generated for the lifetime of the subscription. This helps you:
Advance invoices can be scheduled in two ways:
Advance invoices for a subscription can be scheduled to be generated on specific dates in the future. You must specify the number of billing cycles to be invoiced on each date. A maximum of 5 dates can be specified.
Advance invoices can be scheduled to be generated at fixed intervals of time, where each interval spans the same number of billing cycles of the subscription. The invoice for each interval is generated a specified number of days (days_before_interval) before the start of the interval. You can configure the schedule to end on a certain date or after a specified number of advance invoices have been generated.
The start date of the first interval depends on the number of days remaining from current time till the next renewal of the subscription. If this is more than days_before_interval, the interval begins at the next renewal. On the other hand, if the number of days remaining before the next renewal is less than days_before_interval, the first interval begins at the renewal following the next.
System-generated and immutable unique Id for the advance_invoice_schedule\n.
When the schedule_type\nis fixed_intervals\n, this object gives further details of the schedule.
Specifies when the schedule should end.
\n* after_number_of_intervals -Advance invoices are generated a specified number of times
Advance invoices are generated for as long as the subscription is active.
\n* specific_date -End the advance invoicing schedule on a specific date\n.
The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles\nof the subscription. This parameter is applicable only when fixed_interval_schedule[end_schedule_on]\n= after_number_of_intervals
The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when fixed_interval_schedule[end_schedule_on]\n= specific_date\n.
The number of billing cycles to charge for, on the date specified. Applicable only when schedule_type\nis specific_dates.
The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when schedule_type\nis specific_dates\n.
An alert defines a threshold rule for a metered feature within a subscription. When the usage of a metered feature crosses the configured threshold, Chargebee triggers a webhook notification, enabling you to take action such as notifying the customer, upgrading the plan, or blocking further usage.
Common examples of alerts include:
The alert resource represents configuration only. To check the current runtime state of an alert for a subscription (whether it is within_limit or in_alarm), use the Alert Status endpoints.
Alerts can be created at two levels:
filter_conditions with the plan_price_id field. When multiple filter conditions are provided, they are evaluated with OR semantics: the alert applies if any condition matches.subscription_id when creating the alert. Subscription-scoped alerts cannot have filter_conditions.Important
A global alert and a subscription-scoped alert are mutually exclusive in their parameters: if subscription_id is set, filter_conditions must not be provided, and vice versa.
The threshold object defines when the alert should fire. It has two fields:
mode: Either percentage or absolute.\npercentage: The alert fires when usage reaches the specified percentage of the plan quota. The value must be between 0 and 100 (inclusive).absolute: The alert fires when usage reaches an absolute quantity. The value must be >= 0.value: The numeric threshold at which the alert triggers.The identifier of the subscription this alert is scoped to. Present only for subscription-scoped alerts; null for global alerts.
Whether the alert is currently active. A disabled alert is not evaluated against usage data.
The alert is active and will trigger when the threshold is breached.
\n* disabled -The alert is inactive and will not trigger, regardless of usage.
", "enum" : [ "enabled", "disabled" ], "example" : null }, "meta" : { "type" : "string", "deprecated" : false, "description" : "An optional string field for storing custom metadata with the alert (for example, JSON serialized by your integration). Maximum 65,000 characters.\n", "maxLength" : 65000, "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp (UTC, in seconds) indicating when the alert was created.\n", "example" : null }, "updated_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp (UTC, in seconds) indicating when the alert was last updated.\n", "example" : null } }, "required" : [ "created_at", "id", "metered_feature_id", "name", "type", "updated_at" ], "example" : null }, "AlertStatus" : { "type" : "object", "description" : "An alert status represents the runtime evaluation of an alert for a specific subscription. While the alert resource defines the threshold rule, the alert status tells you whether a subscription is currently within_limit or in_alarm for that rule.
Each alert status tracks:
alarm_status: The current state — within_limit (usage is below the threshold) or in_alarm (usage has breached the threshold).alarm_triggered_at: The timestamp when the alert last entered the in_alarm state. This is null if the alert has never been triggered for this subscription.Note: Alert statuses are computed by Chargebee based on usage data and the alert configuration. They are read-only — you cannot create or update an alert status directly. To change the threshold rule, use the Alerts API.
Timestamp (UTC, in seconds) indicating when the alert last entered the in_alarm state for this subscription. null if the alert has never been triggered.
Addon-item and charge-item prices are purchased with plan-item prices in subscriptions. You can automate this process by configuring certain addons and charges as "attached" to certain plans. This is done at the "item" level. In other words, addon- and charge-items can be attached to plan-items.
Once the attachment is defined, while creating or updating a subscription, the addon- or charge-item prices are selected automatically based on the plan-item price selected . Let's look at the details:
Addons can be attached to plans as recommended, mandatory or optional.
recommended for a plan, the addon is suggested to be applied to subscriptions for the plan in Checkout and Self-Serve Portal. Alternatively, if you build your own payment pages or have a sales team, you can suggest recommended addons to your customers or salespeople on your website or CRM respectivelymandatory for a plan, the addon gets applied to subscriptions for the plan compulsorily, unless removed explicitly. If you do not pass an item price for a mandatory addon when including the plan in a subscription, an addon-item price is automatically applied as explained below.optional neither marks it as recommended or mandatory but allows you a way to set a quantity and billing_cycles for the addon, for when it is applied to subscriptions with the plan.Once an addon has been attached as mandatory, the addon-item price to be applied to the plan-item price is selected based on the following rule: The addon-item price with the same currency as that of the plan-item price and the longest compatible period is selected.
Here's an example:
Consider a plan Standard Cloud Storage has an addon Extra Storage attached to it. Note that each of the two are items. Now consider that they have item prices with the following periods and currencies:
Item price for "Standard Cloud Storage" plan-item:
Item prices for "Extra Storage" addon-item:
For the plan-item price (Standard Cloud Storage, 3 years, AUD), the addon-item prices with matching currencies are the last 4 from the above list:
From among them, the last two have periods that are incompatible with the plan-item price period of 3 years. From the remaining 2 addon-item prices, the one with the longest period is of 18 months. So, "Extra Storage, 18 months, AUD" is selected for mandatory application to the plan item price.
Charges can also be attached to plans. When doing so, you specify the event at which the charge is to be applied to the subscription. For some events that can occur multiple times in a subscription lifetime, you can also set whether to apply the charge each time the event occurs or just once.
There may be multiple item prices for a given attached charge. The item price that matches the currency of the plan-item price is automatically selected for application.
Here's an example:
Consider a plan Standard Cloud Storage has a charge named Implementation Fee attached to it. Now consider their item prices below, with the following periods and currencies:
Item price for "Standard Cloud Storage" plan-item:
Item prices for "Implementation Fee" charge-item:
From among the charge-item prices above, the one compatible with the plan-item price is "Implementation Fee, AUD" since it has the same currency as the plan-item price.
The id\nof the plan-item to which the item is attached.
The type of attachment for the addon. Only applicable for addon-items.
\n* recommended -The addon is recommended to go with the plan-item when using Checkout\nor Portal\n.
\n* optional -The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a quantity\nand billing_cycles\nfor the addon, for when it is applied to subscriptions with the plan.
The addon is attached automatically to the subscription for the plan-item unless explicitly removed\nvia API.
", "enum" : [ "recommended", "mandatory", "optional" ], "example" : null }, "status" : { "type" : "string", "deprecated" : false, "description" : "The item state.\n\\* active -\n\nNew subscriptions can be created with the item.\n\\* deleted -\n\nNo subscriptions allowed for the item.\n\\* archived -\n\nNo new subscriptions allowed for the item.\n", "enum" : [ "active", "archived", "deleted" ], "example" : null }, "quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The default quantity of the addon to be attached when the quantity is not specified while [creating](/docs/api/subscriptions/create-subscription-for-items)\n/[updating](/docs/api/subscriptions/update-subscription-for-items)\nthe subscription.\n", "minimum" : 1, "example" : null }, "quantity_in_decimal" : { "type" : "string", "deprecated" : false, "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](/docs/api/getting-started)\nis enabled.\n", "maxLength" : 33, "example" : null }, "billing_cycles" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires addon billing cycles\nto be enabled for the site.
\nThe value set explicitly for billing_cycles\nwhile applying the addon to a subscription\ntakes precedence over this attribute. This attribute, in turn, has a higher precedence than the value set for the addon-item price\n.
Indicates when the item is charged. This attribute only applies to charge-items.
\n* contract_termination -when a contract term is terminated\n.
\n* subscription_creation -the time of creation of the subscription.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* on_demand -Item can be charged on demand
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This attribute only applies to charge-items.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
The business_entity resource represents a business unit or brand under your organization. Key resources in Chargebee Billing (such as customer, subscriptions, invoices, and transactions) along with the associated site configurations, fall under a business entity. Each Chargebee Billing site has one business entity by default. You may create multiple business entities in the following scenarios:
Creating multiple business entities lets you separate configuration and data for your business units or brands so that you can manage their billing and revenue operations independently.
See also
More information on business entities and the configuration options available.
All API operations in Chargebee have site context. Context restrictions cannot be assigned to API keys. However, if your site has multiple business entities, you can specify the business entity context for an API call by passing a custom HTTP request header.
The table below explains how Chargebee responds to various API calls depending on whether the business entity ID is specified as part of the API call.
Note
Some of the words used here are defined in the Terminology section.
| Operation/Type of operation | Behavior | Examples |
|---|---|---|
Any operation that creates a customer resource |
|
|
Create a resource other than customer |
|
|
| Update/delete a resource |
|
|
| List resources |
|
|
| Retreive a resource |
|
|
This section defines some useful terms for describing how business entities work.
Any resource is always associated with precisely one and only one business entity. We call it the linked business entity of the resource, or simply, the business entity of the resource.
When customer resource is created and no business entity is specified, it is linked to the business entity designated as the default business entity of the site. A site always has a default business entity. Please choose the first business entity details carefully, as it can't be changed later, and this will be your default entity when no business entity is specified.
Any site has data in it. This includes all the various resources such as customers, subscriptions, invoices, comments, and so on. The "context" of an API operation is the subset of site data it has access to. An API operation can only read or write data within its context. By default, an API operation has "site context", which means it has access to the entire site's data. However, when a business entity is specified in an API operation, it has "business entity context", which means that the operation only has access to the data linked to the business entity.
Example
Consider the List customers API. When you call the API without specifying a business entity, its context is that of the site and therefore returns customer resources for the entire site. However, when you specify a business entity, the context is only that of the business entity, and therefore the customer resources of only the selected business entity are returned.
Let's look at the Create checkout for a new subscription API. Say you're calling this API and providing the customer[id] parameter. When no business entity is specified, the operation has site context and therefore looks up the ID among all the customer resources in the site. However, when a business entity is provided, the operation has business entity context and looks up the ID only among the customers linked to that business entity.
While creating an API resource other than a customer, you specify a target resource under which it should be created. For example:
invoice resource for a one-time charge, you must specify either the customer or the subscription resource to which it belongs. The customer or subscription resource, in this case, is the target resource of the invoice.subscription, the target resource of a subscription resource is always a customer resource.quote resource of type change_subscription, the target resource is a subscription resource.Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
business_entity_transfer\nencapsulates the details of the movement of a resource (such as customer\nand subscription\n) from one business_entity\nto another.
Related Endpoints
Unique identifier of the business_entity_transfer.\nChargebee automatically generates this.
The type of the resource that was transferred.
\n* customer -Represents the transfer of a customer\nresource.
Represents the transfer of a subscriptions\nresource linked to a customer\nresource.
The id\nof the deprecated version of the resource. This is the resource linked to the source business_entity\n.
The id\nof the active version of the resource. This is the resource linked to the destination business_entity\n.
The unique identifier of the business_entity\nto which the resource has been transferred.
The unique identifier of the business_entity\nfrom which the resource has been transferred.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
The Chargebee site\nfor which the information has been requested. It is the same as the value of {site}\nprovided as a path parameter.
Subscriptions can run indefinitely or they may run for a fixed number of billing cycles. Subscription can have "contract terms", which define a lock-in period on the subscription for a certain number of billing cycles. This prevents the subscription from being canceled by the customer when it is within the contract term.
The contract term resource described below defines the properties of this lock-in period. This includes the number of billing cycles, the total contract value, the action to be taken at the end of the contract term, and so on. To allow for exceptions, you also have the option of terminating an active contract term and charging a termination fee.
A contract term starts in the active state and ends in the completed state. If the contract was canceled due to non-payment or other reasons, it can end in the canceled or terminated state. A given contract term is always associated with one, and only one subscription. A subscription, however, can be associated with only one active contract term. Over time, a subscription can be associated with several non-active contract terms. The active contract term for a subscription is available as an object within the subscription.
To enable and configure contract terms, follow these steps in the Chargebee UI:
Once contract terms have been configured, the following actions can be performed using the API:
Define a contract term for a subscription and set renewal options for the contract term. The following endpoints support this:
\nRetrieving a historical record of all contract terms for a subscription can be done via the following endpoint:
\nCanceling a contract term can be done via the following endpoints:
\nWhen a contract is canceled mid-term, you can set a termination fee to be levied. Here's how:
charge with price set to the termination fee.charge_on_event parameter to contract_termination. ORsubscription_items[charge_on_event][i] parameter to contract_termination.Once the above steps are done, the termination fee will be charged automatically if you terminate the contract in the middle of its term.
Action to be taken when the contract term completes.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and the subscription renews.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "total_contract_value" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "The sum of the totals\nof all the invoices raised as part of the contract term. For active\ncontract terms, this is a predicted value. The value depends on the type of currency.\nIf the subscription was imported\nwith the contract term, then this value includes the value passed for total_amount_raised\n.
It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for total_amount_raised_before_tax\nis included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.
The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for active\ncontract terms.
Coupons are deductions applied to invoices or invoice line items. They're designed to be consumed by your customers directly. A coupon deduction can either be for a fixed amount or for a percentage of the amount of the invoice or line item.
Note:
If you wish to provide discounts to your customers via API or the Chargebee app, see Discounts API
When both coupons and discounts are applied simultaneously to a subscription or one-time invoice, they're applied in the following order:
| Summary | Description | |
|---|---|---|
| 1 | Line-level, fixed amount coupons | coupon with apply_on = each_specified_item and discount_type = flat |
| 2 | Line-level, fixed amount discounts | discount with apply_on = specific_item_price and type = fixed_amount |
| 3 | Line-level, percentage coupons | coupon with apply_on = each_specified_item and discount_type = percentage |
| 4 | Line-level, percentage discounts | discount with apply_on = specific_item_price and type = percentage |
| 5 | Invoice-level, fixed amount coupons | coupon with apply_on = invoice_amount and discount_type = flat |
| 6 | Invoice-level, fixed amount discounts | discount with apply_on = invoice_amount and type = fixed_amount |
| 7 | Invoice-level, percentage coupons | coupon with apply_on = invoice_amount and discount_type = percentage |
| 8 | Invoice-level, percentage discounts | discount with apply_on = invoice_amount and type = percentage |
For example, consider the following scenario:
A subscription is created with:
The above coupons and discount are applied in the following order:
| Discount or coupon applied | Subtotal at each step | |
|---|---|---|
| 1 | Initial subtotal (plan price + addon price) | $200 + $20 = $220 |
| 2 | 1% off coupon on the addon | $200 + $(20 - 0.02) = $200 + $19.98 = $219.98 |
| 3 | Flat $2 coupon on the invoice | $219.98 - $2 = $217.98 |
| 4 | Flat $5 invoice discount | $217.98 - $5 = $212.98 |
Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
The display name used in web interface for identifying the coupon.
\nNote:
When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.
Specifies the type of discount to be applied.
\n* percentage -A percentage of the original price is deducted as a discount. The discount percentage is specified in discount_percentage.
Learn more\nabout percentage\ncoupons.
A fixed amount is deducted as a discount. The discount amount is specified in discount_amount.
Learn more\nabout fixed_amount\ncoupons.
A specified number of units of the item price are offered for free. The number of free units is specified in discount_quantity.\nThe offer_quantity\noption is valid only when apply_on\nis set to each_specified_item\nand the pricing_model\nof the item price is per_unit.
Learn more\nabout offer_quantity\ncoupons.
Specifies the number of free units provided for the item price\n, without affecting the total quantity sold. This parameter is applicable only when the discount_type\nis set to offer_quantity\n.
Specifies the time duration for which this coupon is attached to the subscription.
\n* forever -The coupon is attached to the subscription and applied on the invoices until explicitly removed.
\n* one_time -The coupon stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
Status of the coupon.
\n* future -The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active.
\n* expired -Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions\nor valid_till\ndate is past. Existing associations remain unaffected.
Cannot be applied to a subscription. Existing associations remain unaffected.
\n* active -Can be applied to a subscription.
\n* deleted -Indicates the coupon has been deleted.
", "enum" : [ "active", "expired", "archived", "deleted", "future" ], "example" : null }, "apply_on" : { "type" : "string", "deprecated" : false, "description" : "The amount on the invoice to which the coupon is applied.
\n* invoice_amount -The coupon is applied to the invoice sub_total\n.
Applies the coupon to specified items (plans, addons, or charges), with the discount applied to each matching invoice.line_item.amount.
Requires applicability to be configured using item_constraints—for example all, criteria, or specific with item_price_ids.
When you attach this coupon to a subscription, at least one of that subscription's plans, addons, or charges must match those rules. If none do, the request fails.
", "enum" : [ "invoice_amount", "each_specified_item" ], "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp indicating when this coupon is created.\n", "example" : null }, "archived_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp indicating when this coupon was archived.\n", "example" : null }, "resource_version" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The version number of this resource. For every change made to the resource, resource_version\nis updated with a new timestamp in milliseconds.
Timestamp indicating when this coupon was last updated.\nNote that this does not change when the redemptions\nattribute is changed. This attribute will be present only if the resource has been updated after 2016-11-09.
The duration of time for which the coupon is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period\n.
The unit of time for period. Applicable only when duration_type\nis limited_period\n.
A period of 1 calendar month.
\n* week -A period of 7 days.
\n* year -A period of 1 calendar year.
\n* day -A period of 24 hours.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "redemptions" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of times this coupon has been redeemed.\n", "minimum" : 0, "example" : null }, "invoice_notes" : { "type" : "string", "deprecated" : false, "description" : "A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)\ndisplayed on the invoice PDF.\n", "maxLength" : 2000, "example" : null }, "meta_data" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "A collection of key-value pairs that provides extra information about the coupon. \\*\\*Note:\\*\\* There's a character limit of 65,535. \\[Learn more\\](/docs/api/advanced-features) .\n", "example" : null }, "deleted" : { "type" : "boolean", "deprecated" : false, "description" : "Indicates whether the coupon has been deleted or not.\n", "example" : null }, "item_constraints" : { "type" : "array", "deprecated" : false, "description" : "The list of item constraints.\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "item_type" : { "type" : "string", "deprecated" : false, "description" : "Item type for which this criteria is applicable for.\n\\* charge -\n\nCharge\n\\* plan -\n\nPlan\n\\* addon -\n\nAddon\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "constraint" : { "type" : "string", "deprecated" : false, "description" : "Constraint applicable for the item\n\\* specific -\n\nCoupon applicable to specific items.\n\\* all -\n\nCoupon applicable to all items.\n\\* criteria -\n\nCoupon applicable based on criteria.\n\\* none -\n\nCoupon not applicable to any items.\n", "enum" : [ "none", "all", "specific", "criteria" ], "example" : null }, "item_price_ids" : { "type" : "array", "deprecated" : false, "description" : "List of item price ids for which this coupon is applicable.\n", "items" : { "example" : null }, "example" : null } }, "required" : [ "constraint", "item_type" ], "example" : null }, "example" : null }, "item_constraint_criteria" : { "type" : "array", "deprecated" : false, "description" : "The list of item constraint criteria.\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "item_type" : { "type" : "string", "deprecated" : false, "description" : "Item type for which this criteria is applicable for.\n\\* charge -\n\nCharge is a type of item\n\\* plan -\n\nPlan is a type of item\n\\* addon -\n\nAddon is a type of item\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "currencies" : { "type" : "array", "deprecated" : false, "description" : "List of currencies ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)\n) for which this coupon is applicable.\n", "items" : { "example" : null }, "example" : null }, "item_family_ids" : { "type" : "array", "deprecated" : false, "description" : "List of families for which this coupon is applicable.\n", "items" : { "example" : null }, "example" : null }, "item_price_periods" : { "type" : "array", "deprecated" : false, "description" : "List of frequencies for which this coupon is applicable. Allowed frequencies are \\[day, week, month, year\\].\n", "items" : { "example" : null }, "example" : null } }, "required" : [ "item_type" ], "example" : null }, "example" : null }, "coupon_constraints" : { "type" : "array", "deprecated" : false, "description" : "List of constraints applicable on the redemption of this coupon.\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "entity_type" : { "type" : "string", "deprecated" : false, "description" : "The resource type for the constraint. This, along with type\nand value\n, helps define the specific rule applied.
The constraint is based on customer\nrecords.
Type of coupon constraints
\n* unique_by -Indicates - when entity_type\nis customer
customer\nattribute. The customer\nattribute is specified using value.\nFor example, if value\nis email\n, then the coupon can be redeemed only once for every unique value of customer.email.\nIn other words, when there are multiple customer\nrecords with the same value for email\n, once the coupon has been redeemed for one of those customer records, no further redemptions of the coupon are allowed for any of those customer\nrecords.The coupon is applicable only for new customer(s). A customer will be considered as new_customer\nwhen they do not have any prior non-void, non-zero-dollar invoices.
The coupon is applicable only for existing customer(s). A customer will be considered as existing_customer\nwhen they have at least one non-void, non-zero-dollar invoice.
The coupon can be redeemed up to a set number of times for a specific resource type. The maximum redemptions are specified using value\n, and the resource type is specified using entity_type.\nFor example, if entity_type\nis customer\nand value\nis 10\nthen the coupon can only be redeemed up to 10 times for any particular customer\nrecord.
The value of the coupon constraint. The possible values depend on the value of constraints[type]:
When type is unique_by, then value can be email or id.
When type is max_redemptions, then value can be any integer in the range 1 coupon.max_redemptions, inclusive.
When type is new_customer or existing_customer then value can be based_on_invoice.
A Credit Note is a document that specifies the money owed by a business to its customer. The seller usually issues a Credit Note for the same or lower amount than the invoice, and then repays the money to the customer or set it off against other 'due' invoices.
Credit notes in Chargebee are categorized into three types:\n1. adjustment: Adjustment credit notes are used to adjust the amount of an existing invoice in the payment_due or not_paid status. Use this type of credit note to reduce the invoice amount, typically as a discount to the customer.\nAdjustment credit notes are automatically created in the following cases:
payment_due or not_paid status.\n2. refundable: Refundable credit notes allow you to return a certain amount to the customer. These credits can be:paid status. Refundable credits are applied to future invoices or can be refunded to the original payment method.\n3. store: Store credit notes are created for paid or partially_paid invoice status during subscription changes, such as upgrades, downgrades, or cancellations.\nKey characteristics of store credits:Note:\nIf you have enabled consolidated invoicing\n, to know the subscriptions attached with a credit note you have to refer line_item's\nsubscription_id\n. The credit note's subscription_id\nshould not\nbe used (which will be null\nif the credit note has lines from multiple subscriptions).
Impact on reference invoice
The following updates are made to the reference invoice when a credit note is created/imported:
type is adjustment:\nadjustment_credit_notes[] attribute of the invoice.amount_due is reduced by the credit note total.status is updated to paid if the invoice amount_due equals the credit note total.status does not change if the invoice amount_due is greater than credit note total.type is refundable:\nissued_credit_notes[] attribute of the invoice.status does not change.type is store:\nissued_credit_notes[] attribute of the invoice.status does not change.Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
This attribute is returned only if additional resources are available. Use this value as the input parameter for line_items_offset to retrieve the next set of resources.
Note:
Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the round_off_amount.\nIf there is no round-off amount\n, it will display 0\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The unique ID of the business entity\nof this credit_note. This is always the same as the business entity of the invoice referred to by reference_invoice_id.
Quantity of the recurring item\nwhich is represented by this line item. For metered\nline items, this value is updated from usages\nonce when the invoice is generated as pending\nand finally when the invoice is closed\n.
The decimal representation of the unit amount of the line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the amount for the line_item\n, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\n* zero_value_item -If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.
\n* reverse_charge -If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
\n* tax_not_configured -If tax is not enabled for the site
\n* high_value_physical_goods -If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied
\n* tax_not_configured_external_provider -If the tax is not configured for the country in 3rd party tax provider.
\n* customer_exempt -If the Customer is marked as Tax exempt
\n* region_non_taxable -If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction
\n* product_exempt -If the Plan or Addon is marked as Tax exempt
\n* zero_rated -If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
\n* export -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* per_unit -Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The tax amount. This is set to the corresponding value on the invoice (invoice.line_item_taxes[i].tax_amount), prorated by the ratio of credit_note.total to invoice.total.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The unique id of the line item that this deduction is for. Is required when discounts[entity_type]\nis item_level_coupon\nor document_level_coupon\n.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice.
\n* document_level_discount -The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The type of discount that is applied to the line item. Relevant only when discounts[entity_type]\nis one of item_level_discount\n, item_level_coupon\n, document_level_discount\n, or document_level_coupon
when percentage is applied as discount
\n* fixed_amount -when amount is applied as discount
", "enum" : [ "fixed_amount", "percentage" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
The tax amount. This is set to the corresponding value on the invoice (invoice.taxes[i].amount), prorated by the ratio of credit_note.total to invoice.total.
The status of this transaction.
\n* needs_attention -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
The transaction got voided or authorization expired at gateway.
\n* late_failure -Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.
\n* timeout -Transaction failed because of Gateway not accepting the connection.
\n* success -The transaction is successful.
\n* failure -Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure
\n* in_progress -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.
", "enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ], "example" : null }, "txn_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates when this transaction occurred.\n", "example" : null }, "txn_amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Total amount of the transaction\n", "minimum" : 0, "example" : null }, "refund_reason_code" : { "type" : "string", "deprecated" : false, "description" : "Reason code for the refund. Must be one from a list of reason codes set in the Chargebee app in **Settings \\> Configure Chargebee \\> Reason Codes \\> Credit Notes \\> Refund Credit Note**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive\n", "maxLength" : 100, "example" : null } }, "required" : [ "applied_amount", "applied_at", "txn_id" ], "example" : null }, "example" : null }, "linked_tax_withheld_refunds" : { "type" : "array", "deprecated" : false, "description" : "The details of refunds recorded against the invoice.linked_taxes_withheld\ncomponent of the invoice\nassociated\nwith this credit_note.
An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_.\nFor example, tax_wh_16BdDXSlbu4uV1Ee6\n.
Current status of the invoice.
\n* not_paid -Indicates the payment is not made and all attempts to collect is failed.
\n* paid -Indicates a paid invoice.
\n* voided -Indicates a voided invoice.
\n* posted -Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
\n* pending -The invoice is yet to be closed (sent for payment collection). An invoice is generated with this status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.\nThe invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.
Indicates the payment is not yet collected and is being retried as per retry settings.
", "enum" : [ "paid", "posted", "payment_due", "not_paid", "voided", "pending" ], "example" : null }, "tax_application" : { "type" : "string", "deprecated" : false, "description" : "Specifies how tax is handled for invoice allocations made from this credit note.\n\\* pre_tax -\n\nAllocations are applied before tax calculation.\n\\* post_tax -\n\nAllocations are applied after tax calculation.\n", "enum" : [ "pre_tax", "post_tax" ], "example" : null } }, "required" : [ "allocated_amount", "allocated_at", "invoice_id", "invoice_status" ], "example" : null }, "example" : null }, "shipping_address" : { "type" : "object", "deprecated" : false, "description" : "Shipping address for the credit note.\n", "properties" : { "first_name" : { "type" : "string", "deprecated" : false, "description" : "The first name of the contact.\n", "maxLength" : 150, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "The last name of the contact.\n", "maxLength" : 150, "example" : null }, "email" : { "type" : "string", "format" : "email", "deprecated" : false, "description" : "The email address.\n", "maxLength" : 70, "example" : null }, "company" : { "type" : "string", "deprecated" : false, "description" : "The company name.\n", "maxLength" : 250, "example" : null }, "phone" : { "type" : "string", "deprecated" : false, "description" : "The phone number.\n", "maxLength" : 50, "example" : null }, "line1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1\n", "maxLength" : 150, "example" : null }, "line2" : { "type" : "string", "deprecated" : false, "description" : "Address line 2\n", "maxLength" : 150, "example" : null }, "line3" : { "type" : "string", "deprecated" : false, "description" : "Address line 3\n", "maxLength" : 150, "example" : null }, "city" : { "type" : "string", "deprecated" : false, "description" : "The name of the city.\n", "maxLength" : 50, "example" : null }, "state_code" : { "type" : "string", "deprecated" : false, "description" : "The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The unique id\nfor the e-invoice. This is auto-generated by Chargebee.
The status of processing the e-invoice. To obtain detailed information about the current status\n, see message\n.
An acknowledgment confirming that the application response was successfully received by the receiving entity.
\n* under_query -The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
\n* rejected -The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.
\n* scheduled -Sending the e-invoice to the customer has been scheduled.
\n* paid -The receiving entity has confirmed that the e-invoice has been paid.
\n* conditionally_accepted -The e-invoice has been accepted with conditions.
\n* accepted -The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
\n* skipped -The e-invoice was not sent. This could be due to missing information or because the entity_identifier\nis not registered on the e-invoicing network.
The e-invoice has been successfully delivered to the customer.
\n* failed -The e-invoice was sent and there was an error due to which it was not delivered.
\n* in_progress -The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
\n* in_process -The e-invoice is currently being processed by the receiving entity.
\n* registered -The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
", "enum" : [ "scheduled", "skipped", "in_progress", "success", "failed", "registered", "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ], "example" : null }, "message" : { "type" : "string", "deprecated" : false, "description" : "Detailed information about the status of the e-invoice. When status\nis skipped\nor failed\n, this contains the reason or error details. The following are some valid examples:
Chargebee's Multi-currency feature allows you to create Plans in multiple currencies, enabling your customers to conveniently pay in their preferred local currency. Please review this documentation to understand the multi-currency feature in Chargebee.
This currency resource contains exchange rate configurations associated with a specific currency. The multi-currency feature must be enabled, and all prerequisites must be addressed to successfully add a new currency via the API.\nTo invoke a single currency-specific API like update, retrieve, and more, the currency ID has to be passed as a path parameter. You can use list API to fetch the IDs of each currency configured in your site to use with the currency-specific APIs below. Chargebee supports billing in over 100 currencies.\nOn this page, you can find information about how currency units are expressed in the API, as well as some pointers to keep in mind when using multiple currencies.
By default, the Chargebee API supports only whole numbers for currency values. To allow for fractional (decimal) values, you must enable the multi-decimal pricing feature. Additionally, the units in which currencies are expressed in the API depend on whether the currency is zero-decimal and whether multi-decimal pricing is enabled.
By default, Chargebee supports currency values in whole numbers; fractions are not supported. In the API, currency values can be identified by checking their data types. For all whole number currency values in this API, the data type is indicated as "in cents" in this documentation.
The specific unit used for the currency in the API depends on whether it is a zero-decimal currency:
15.153.When multi-decimal pricing is enabled in Chargebee, you can work with fractional currency values using dedicated API parameters and attributes of the String type. Usually, these attributes and parameters have the suffix _in_decimal in their names. The value is expressed in the major unit of the currency, which is the unit represented by its ISO 4217 code. For example, $1.6782 should be provided as 1.6782. The maximum number of decimal places supported by the API can be configured in the admin console.
Note: For zero-decimal currencies, such as the Japanese Yen (JPY), decimal places are not allowed.
While Chargebee supports multiple decimal places for currency values, at the invoice line item\n-level, the amount\nattribute is always rounded off to two decimal places in the major unit of the currency. The major unit of a currency is the unit represented by its\nISO 4217 code\n.
The rounding logic used is ROUND_HALF_EVEN\n. For example, if the quantity\nis 0.0765 and unit_amount\nis $10.674, the line item amount\nis (0.0765 x $10.674) = $0.816561 and is rounded off to $0.82.
By default, Chargebee is able to process transactions in only one currency. However, you can enable the multi-currency feature to support more currencies. The first currency enabled in Chargebee also becomes the "base currency" by default. If you have multiple currencies enabled and want to change the base currency for your site, reach out to Support for assistance.
Warning
For some API endpoints, the currency_code parameter becomes required when the multi-currency feature is enabled. Before enabling the feature for your site, ensure that you update your code to provide the currency_code parameter when calling the endpoints listed in the next section.
The following endpoints require the currency_code\nparameter to be passed when the multi-currency feature has been enabled.
Customer-related endpoints
\nInvoice-related endpoints
\nProduct catalog-related endpoints
\nThis field mentions whether the foreign currency is active or archived. If the value is false\nthe foreign currency is archived else it is active.
This represents the exchange rate type set for the currency.
\n* auto -If forex_type\nis auto\n, conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers).
If forex_type\nis manual\n, you will be able to set the conversion rate for the currency. You need to update the exchange rate each time your exchange rate provider changes it.
Check whether this is a base currency or not. The value of the attribute is true\nwhen the currency matches the site's base currency.
This attribute shows the exchange rate in decimal. When forex_type\nis manual\nyou have to set the exchange rate for additional currencies in manual_exchange_rate\nfield.
Represents a customer, which can be an individual or organization that subscribes to your products or services. The customer resource associates with subscriptions, card information, and billing addresses. The customer details include their ID, name, contact information, and any custom attributes you'd like to associate with them.
Breaking Change:
billing_address and vat_number and replaces them with values from the request.billing_address and vat_number.The unique identifier of the customer resource. You have the option to specify this value when creating a customer. If not specified, Chargebee automatically generates a unique identifier.
Tip\nWhen the customer resource is transferred to a different business_entity, Chargebee assigns a new random identifier to the id attribute. The original identifier is preserved for the transferred copy of the customer resource. (See also: Mechanics of business entity transfer.)
The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
When the customer has a payment_method\nof type\ncard\n, this attribute determines whether to automatically charge the card whenever an invoice status\nis payment_due\n.
Note\nThis setting can be overridden for individual subscriptions of the customer.
Chargebee automatically charges the card for invoices that enter payment_due\nstatus\n.
Automatic charging is disabled; manual payment is required for due invoices.
", "enum" : [ "on", "off" ], "example" : null }, "offline_payment_method" : { "type" : "string", "deprecated" : false, "description" : "The preferred offline payment method for the customer.\n\\* sepa_credit -\n\nSEPA Credit\n\\* cash -\n\nCash\n\\* no_preference -\n\nNo Preference\n\\* bank_transfer -\n\nBank Transfer\n\\* check -\n\nCheck\n\\* eu_automated_bank_transfer -\n\nEU Automated Bank Transfer\n\\* jp_automated_bank_transfer -\n\nJP Automated Bank Transfer\n\\* uk_automated_bank_transfer -\n\nUK Automated Bank Transfer\n\\* custom -\n\nCustom\n\\* boleto -\n\nBoleto\n\\* mx_automated_bank_transfer -\n\nMX Automated Bank Transfer\n\\* us_automated_bank_transfer -\n\nUS Automated Bank Transfer\n\\* ach_credit -\n\nACH Credit\n", "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ], "example" : null }, "net_term_days" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days from invoice.date until payment for the invoice is due.
Note\nApplicable only when the customer's billing_address.country is New Zealand, Australia, or in the EU.
When the customer uses a card payment source, this attribute specifies whether the country of the customer and the card issuer are the same.\nThe following three location indicators are compared:
\nbilling_address.country.created_from_ip belongs.true, otherwise it is set to false.The IP address of the customer when this customer record was created. It's mainly used for referral integrations and validating VAT if the customer is in the EU or UK.\nDepending on the method used to create the customer record, the field is set as follows:
\ncustomer resource through the API, you must include the customer's IP address in a custom HTTP request header (chargebee-request-origin-ip) for Chargebee to capture it.customer resources created through Chargebee Checkout, Chargebee automatically captures the IP address of the customer.customer resource via the Chargebee Billing UI, this field is not relevant and the value must be ignored.Specifies if the customer is liable for tax
\n* taxable -Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.
\n* exempt -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
Note\nApplicable only when Calendar Billing with support for customer-specific billing date is enabled and billing_date_mode is manually_set.
Specifies the day of the month for subscription renewals on month-based or year-based plans. Month-based and year-based plans are item_price\nresources where the item_type\nis set to plan\nand period_unit\nis set to month\nand year\nrespectively.
Example
billing_date is set to 15, month-based renewals occur on the 15th of the month. It's important to note that if the value is set to 31, renewals align with the last day of the month. Additionally, in February, a billing_date of 29, 30, or 31 aligns renewals for the last day of February.billing_date of 15 and a billing_month of 7 schedules the renewal on the 15th of July.Note\nApplicable only when Calendar Billing with support for customer-specific billing date is enabled and billing_date_mode is manually_set.
Specifies the renewal month for subscriptions on year-based plans. Year-based plans are item_price\nresources where item_type\nis set to plan\nand period_unit\nis set to year.
Example\nThe renewal date is 15th July when billing_date is 15 and billing_month is 7.
Note\nApplicable only when Calendar Billing with support for customer-specific billing date is enabled and billing_date_mode is manually_set.
Indicates whether this customer's billing_date\nand billing_month\nvalues can be changed via the Change billing date API\n.
billing_date\nand billing_month\ncan be adjusted via API.
billing_date\nand billing_month\nare fixed as per Chargebee site settings\nand not modifiable via API.
Note: Present only when the customer has been transferred between business entities.
Represents the id of the active version of the customer resource.
Tip: If the id and active_id of a customer resource are the same, this indicates that you are working with the active version of that customer resource.
Total unused payments associated with the customer. These are automatically applied to new invoices subject to limits set at the site level which can be overridden for subscriptions via subscription.billing_override.
Constraints
balances[i].excess_payments where balances[i].currency_code is the same as the preferred_currency_code.Determines whether the customer is e-invoiced. When set to true\nor not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (billing_address.country\n). When set to false\n, the customer is not e-invoiced even if e-invoicing is enabled for their country.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
Indicates that this resource has been deleted when the value is true\n.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Indicates whether invoices raised on the same day for the customer are consolidated. When present, this value overrides the default configuration at the site-level. This attribute is applicable only when Consolidated Invoicing is enabled.
Note:
Any invoices raised when a subscription activates from in_trial or future status, are not consolidated by default. Contact Support to enable consolidation for such invoices.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Total unused payments associated with the customer. These are automatically applied to new invoices subject to limits set at the site level which can be overridden for subscriptions via subscription.billing_override.
Refundable credits balance of this customer. These are automatically applied to new invoices subject to limits set at the site level which can be overridden for subscriptions via subscription.billing_override.
Each element of the entity_identifiers[]\narray identifies a specific customer entity with the e-invoicing system. If the customer has only one entity identifier whose value\nis the vat_number\n, then this array is not needed as the scheme\ncan be provided via entity_identifier_scheme.\nThis array holds any additional entity identifiers that the customer may have.
The unique id for the entity_identifier\nin Chargebee. When not provided, it is autogenerated.
The value of the entity_identifier.\nThis identifies the customer entity on the Peppol network. For example: 10101010-STO-10\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The Peppol BIS scheme associated with the vat_number\nof the customer. This helps identify the specific type of customer entity. For example, DE:VAT\nis used for a German business entity while DE:LWID45\nis used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country.\nSee list of possible values\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The standard used for specifying the entity_identifier\nscheme.\nCurrently, only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The id\nof the immediate parent of this customer under account hierarchy. If the customer is the root of the hierarchy, this attribute isn't returned.
The id\nof the customer responsible for paying the invoices for this customer. This ID must match either this customer's ID or the invoice_owner_id\n.
The id\nof the customer who receives the invoice for charges incurred by the customer. This ID must match either this customer or one of its ancestors.
When the customer is part of an account hierarchy, this attribute defines the level of access that the parent account has to the customer's information.\nNote:\nthe 'parent' is the customer whose id is payment_owner_id.\nHowever, if the payment_owner_id\nis the customer itself, then the parent is parent_id\n.
The customer_entitlement resource can be viewed as a subset of the subscription_entitlement resource enhanced with the customer's ID. It is introduced to help retrieve all subscription entitlements for a specific customer.
The display name for the entitlement level. The value is automatically generated based on feature.type:
feature.type is range or quantity: the name is the space-separated concatenation of value and the pluralized form of feature.unit. For example, if value is 20 and feature.unit is user, then name becomes 20 users.feature.type is custom, the name is the same as value.feature.type is switch: name is set to Available when value is true; it's set to Not Available when value is false.When true\n, indicates that the subscription_entitlement\nis enabled.
See also:\nEnable or disable subscription entitlement.
The ID of the item price (addon\nor charge\n) whose price should change according to the plan-item it is applied to.
The differential price. If the pricing model of the item_price_id\nis tiered\n, volume\n, or stairstep\n, pass tiers\ninstead of this.
The price of the item when the pricing_model is flat_fee.\nWhen the pricing model is per_unit\n, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when multi-decimal pricing\nis enabled.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
List of quantity-based pricing tiers for the differential price. Applicable only for tiered\n, volume\n, and stairstep\npricing_model\ns. The tiers are exactly the same as those set for the item price. Only the price\nattribute for the various tiers can be overridden for the differential price.
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.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
When item_price_id\nis a charge-item, you can specify the plan period for which the price applies. Although an array, currently you can specify only one period. In other words, only index 0\nis allowed. Create another differential price to specify another period. Is permitted only when item_price_id\nis a charge-item.
The unit of time for period\n.
A period of 7 days.
\n* year -A period of 1 calendar year.
\n* month -A period of 1 calendar month.
\n* day -A period of 24 hours.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "period" : { "type" : "array", "deprecated" : false, "description" : "The billing period of the plan in period_unit\ns. For example, a 6 month plan has period\nas 6 and period_unit\nas month\n.
A discount, just like coupons, represents a deduction from the amounts in an invoice. While coupons are typically used by your customers, discounts can be directly applied to subscriptions by your sales team while negotiating new deals or upgrades. If the negotiations are on the price itself, the price override feature helps adjust the price further.
Although a discount appears as a deduction on an invoice, it is applied to a subscription while creating or updating the subscription. Every discount in Chargebee is attached to only one subscription.
Note:
A discount can be added to a subscription by calling either Create subscription or Update subscription. Once added, the discount is applied to all subsequent invoices if apply_on is set to invoice_amount. When apply_on = specific_item_price, the discount is applied (as a discount.line_item_discount) in each invoice of the subscription that contains the specified item.
A discount can be added to an invoice using Create invoice for items and one-time charges using the discounts parameter.
A discount can be added to a quote using the following operations:
A discount can be added to an estimate using the following endpoints:
A discount can be removed by calling Update subscription with the relevant discounts[operation_type][] set to remove. Also, discounts that have duration_type as one_time or limited_period are removed automatically upon expiry.
A discount can be removed from a quote using the following operations:
A discount can be removed from an estimate using the following operation:
A discount is associated with exactly one subscription. You can fetch all the discounts currently attached to a subscription by calling the List discounts for a subscription API or by passing include_discounts as true while creating, importing, updating or retrieving a subscription.
When both coupons and discounts are applied simultaneously to a subscription or one-time invoice, they're applied in the following order:
| Summary | Description | |
|---|---|---|
| 1 | Line-level, fixed amount coupons | coupon with apply_on = each_specified_item and discount_type = flat |
| 2 | Line-level, fixed amount discounts | discount with apply_on = specific_item_price and type = fixed_amount |
| 3 | Line-level, percentage coupons | coupon with apply_on = each_specified_item and discount_type = percentage |
| 4 | Line-level, percentage discounts | discount with apply_on = specific_item_price and type = percentage |
| 5 | Line-level, offer quantity coupons | coupon with apply_on = each_specified_item and discount_type = offer_quantity |
| 6 | Line-level, offer quantity discounts | discount with apply_on = specific_item_price and discount_type = offer_quantity |
| 7 | Invoice-level, fixed amount coupons | coupon with apply_on = invoice_amount and discount_type = flat |
| 8 | Invoice-level, fixed amount discounts | discount with apply_on = invoice_amount and type = fixed_amount |
| 9 | Invoice-level, percentage coupons | coupon with apply_on = invoice_amount and discount_type = percentage |
| 10 | Invoice-level, percentage discounts | discount with apply_on = invoice_amount and type = percentage |
For example, consider the following scenario:
A subscription is created with:
The above coupons and discount are applied in the following order:
| Discount or coupon applied | Subtotal at each step | |
|---|---|---|
| 1 | Initial subtotal (plan price + addon price) | $200 + $20 = $220 |
| 2 | 1% off coupon on the addon | $200 + $(20 - 0.02) = $200 + $19.98 = $219.98 |
| 3 | Flat $2 coupon on the invoice | $219.98 - $2 = $217.98 |
| 4 | Flat $5 invoice discount | $217.98 - $5 = $212.98 |
The name of the discount as it should appear on customer-facing pages and documents such as invoices\nand hosted pages.\nThis is auto-generated based on the type\n, amount\n, and currency_code\nof the discount. For example, it can be 10% off\nor 10$ off\n.
The type of discount.\nPossible value are:
\n* percentage -The specified percentage will be given as discount.
\n* fixed_amount -The specified amount will be given as discount.
\n* offer_quantity -A specified number of units of the item price are offered for free. The number of free units is specified in quantity.\nThe offer_quantity\noption is valid only when apply_on\nis set to each_specified_item\nand the pricing_model\nof the item price is per_unit\n.
The percentage of the original amount that should be deducted from it. Only applicable when discount.type\nis percentage.
The value of the discount. The format of this value\ndepends on the kind of currency. This is only applicable when discount.type\nis fixed_amount.
Specifies the number of free units provided for the item, without affecting the total quantity sold. This parameter is applicable only when discount.type\nis offer_quantity.
The currency code (ISO 4217 format\n) of the discount. This is only applicable when discount.type\nis fixed_amount\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 1 calendar year.
\n* month -A period of 1 calendar month.
\n* week -A period of 7 days.
\n* day -A period of 24 hours.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "included_in_mrr" : { "type" : "boolean", "deprecated" : false, "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for limited_period\nduration type discount.
Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
The index number of the subscription to which the item price is added. Provide a unique number between 0\nand 4\n(inclusive) for each subscription that is to be created.
Requesting to download a file through this API will return the download_url attribute as the response. This attribute will contain a URL that will allow the requested content to be downloaded.
The time until which the download_url\nis valid.
The unique id for the e-invoice. This is auto-generated by Chargebee.
The status of processing the e-invoice. To obtain detailed information about the current status, see message.
The e-invoice was sent and there was an error due to which it was not delivered.
\n* in_progress -The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
\n* success -The e-invoice has been successfully delivered to the customer.
\n* scheduled -Sending the e-invoice to the customer has been scheduled.
\n* registered -The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
\n* skipped -The e-invoice was not sent. This could be due to missing information or because the entity_identifier is not registered on the e-invoicing network.
Detailed information about the status of the e-invoice. When status is skipped or failed, this contains the reason or error details. The following are some valid examples:
The entitlement resource establishes a connection between a feature\nand an item\nor an item_price\nin Chargebee Billing. By defining this relationship, it specifies the scope of access or rights the item or item price has in relation to that particular feature.
The unique identifier of the entity being granted entitlement to a specific feature.
The type of the entity that holds this entitlement.
\n* plan -Indicates that the entity is an item with type set to plan.
Indicates that the entity is an item with type set to addon.
Indicates that the entity is an item_price associated with an item with type set to addon.
Indicates that the entity is an item with type set to charge.
Indicates that the entity is an item_price associated with an item of type plan.
The unique identifier of the feature to which the entity gains entitlement.
The name\nof the feature associated with this entitlement.
The level of entitlement that the entity has towards the feature. The possible values depend on the value of feature.type\n:
When feature.type is quantity and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any one of feature.levels[value][].
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can be:
feature.levels[value][]unlimited (case-insensitive), indicating unlimited entitlement.When type is range and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any whole number between levels[value][0] and levels[value][1] (inclusive).
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can be:
levels[value][0]unlimited (case-insensitive), indicating unlimited entitlement.When type is custom, then the value can be any one of feature.levels[value][].
When type is switch, then the value is set as available or true.
The display name for the entitlement level. The value is automatically generated based on feature.type:
feature.type is quantity or range, the name is the space-separated concatenation of value and the plural form of feature.unit. For instance, if value is 20 and feature.unit is user, the name will be 20 users.feature.type is custom, the name matches the value.feature.type is switch, the name is set to Available when value is true; it's set to Not Available when value is false.subscriptions inherit entitlements from items and/or item prices that are in them. Even so, there are many reasons why you may want to override the inherited entitlements on a subscription:
feature that the items on their subscription are not entitled to.feature.level without having to pay more.feature because it is irrelevant to them.feature bundles for each subscription instead of grouping features into a product catalog of items.This API helps you implement each of the above use cases, offering a method to override the entitlements for a subscription at the subscription, item price, or charge-item level.
entitlement_override expiry
If expires_at has been set, then the entitlement_override object is no longer returned after expires_at has passed. The expiration of an entitlement_override does not trigger any event immediately. However, after expiry, the entitlement_override record gets deleted within 12 hours. This deletion triggers the entitlement_overrides_auto_removed event which can be considered as a notification, albeit delayed, for one or more entitlement_overrides having expired.
The id of the subscription to which this entitlement override belongs.
The id of the feature for which the entitlement override is being set.
The name\nof the feature\ntowards which this entitlement override has been granted.
The level of entitlement that the item has towards the feature. The possible values depend on the value of feature.type\n:
When feature.type is quantity and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any one of feature.levels[value][].
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can also be:
feature.levels[value][]unlimited (case-insensitive), indicating unlimited entitlement.When type is range and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any whole number between levels[value][0] and levels[value][1] (inclusive).
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can be:
levels[value][0]unlimited (case-insensitive), indicating unlimited entitlement.When type is custom, then the value can be any one of feature.levels[value][].
When type is switch, then the value is set as true if the feature is available; it is set as false when the feature is unavailable.
The display name for the entitlement level. The default values are auto-generated based on feature.type as follows:
feature.type is quantity or range, then name is the space-separated concatenation of value and the pluralized version of feature.unit. For example, if value is 20 and feature.unit is user, then name becomes 20 users.feature.type is custom, then name is the same as value.feature.type is switch, the name is set to Available when value is true; it's set to Not Available when value is false.The expiry date for the entitlement_override. The entitlement_override object is no longer returned after this date has passed.
Constraints
\nApplicable only for subscription-level entitlement overrides. i.e. Not applicable whenentity_id and entity_type are set.The starting date and time for the entitlement override. It indicates when the override becomes effective.
\nConstraints
\nApplicable only for subscription-level entitlement overrides. i.e. Not applicable whenentity_id and entity_type are set.The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and the subscription renews.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "total_contract_value" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "The sum of the totals\nof all the invoices raised as part of the contract term. For active\ncontract terms, this is a predicted value. The value depends on the type of currency.\nIf the subscription was imported\nwith the contract term, then this value includes the value passed for total_amount_raised\n.
It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for total_amount_raised_before_tax\nis included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.
The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for active\ncontract terms.
Applicable only when End-of-trial Action\nhas been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.
\n* site_default -The action configured for the site\nat the time when the trial ends, takes effect. This is the default value when trial_end_action\nis not\ndefined for the plan.
The action configured for the site\nat the time when the trial ends, takes effect. This is the default value when trial_end_action\nis defined for the plan.
The subscription cancels.
\n* activate_subscription -The subscription activates and charges are raised for non-metered items.
", "enum" : [ "site_default", "plan_default", "activate_subscription", "cancel_subscription" ], "example" : null }, "next_billing_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Date on which the next billing happens. This will be null for non-renewing and cancelled subscriptions.\n", "example" : null }, "pause_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The date on which subscription will be paused. Applicable only to paused or scheduled pause subscriptions\n", "example" : null }, "resume_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The date on which subscription will be resumed. Applicable only to paused or scheduled pause subscriptions\n", "example" : null }, "shipping_address" : { "type" : "object", "deprecated" : false, "description" : "Represents the shipping address when the 'estimate' operations are invoked.\n", "properties" : { "first_name" : { "type" : "string", "deprecated" : false, "description" : "The first name of the contact.\n", "maxLength" : 150, "example" : null }, "last_name" : { "type" : "string", "deprecated" : false, "description" : "The last name of the contact.\n", "maxLength" : 150, "example" : null }, "email" : { "type" : "string", "format" : "email", "deprecated" : false, "description" : "The email address.\n", "maxLength" : 70, "example" : null }, "company" : { "type" : "string", "deprecated" : false, "description" : "The company name.\n", "maxLength" : 250, "example" : null }, "phone" : { "type" : "string", "deprecated" : false, "description" : "The phone number.\n", "maxLength" : 50, "example" : null }, "line1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1\n", "maxLength" : 150, "example" : null }, "line2" : { "type" : "string", "deprecated" : false, "description" : "Address line 2\n", "maxLength" : 150, "example" : null }, "line3" : { "type" : "string", "deprecated" : false, "description" : "Address line 3\n", "maxLength" : 150, "example" : null }, "city" : { "type" : "string", "deprecated" : false, "description" : "The name of the city.\n", "maxLength" : 50, "example" : null }, "state_code" : { "type" : "string", "deprecated" : false, "description" : "The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* cancel -Contract term completes and subscription is canceled.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The sum of the totals\nof all the invoices raised as part of the contract term. For active\ncontract terms, this is a predicted value. The value depends on the type of currency.\nIf the subscription was imported\nwith the contract term, then this value includes the value passed for total_amount_raised\n.
It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for total_amount_raised_before_tax\nis included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.
The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for active\ncontract terms.
The details of the line items in this invoice estimate.
\nNote
Line items that meet both the following conditions are not returned:
metered.line_item.amount is 0.Quantity of the recurring item\nwhich is represented by this line item. For metered\nline items, this value is updated from usages\nonce when the invoice is generated as pending\nand finally when the invoice is closed\n.
The decimal representation of the unit amount of the line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the amount for the line_item\n, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\n* zero_value_item -If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.
\n* tax_not_configured_external_provider -If the tax is not configured for the country in 3rd party tax provider.
\n* reverse_charge -If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
\n* region_non_taxable -If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction
\n* tax_not_configured -If tax is not enabled for the site
\n* high_value_physical_goods -If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied
\n* product_exempt -If the Plan or Addon is marked as Tax exempt
\n* zero_rated -If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
\n* export -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
If the Customer is marked as Tax exempt
", "enum" : [ "tax_not_configured", "region_non_taxable", "export", "customer_exempt", "product_exempt", "zero_rated", "reverse_charge", "high_value_physical_goods", "zero_value_item", "tax_not_configured_external_provider" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type\n", "maxLength" : 100, "example" : null }, "customer_id" : { "type" : "string", "deprecated" : false, "description" : "A unique identifier for the customer this line item belongs to\n", "maxLength" : 100, "example" : null } }, "required" : [ "date_from", "date_to", "description", "entity_type", "is_taxed", "unit_amount" ], "example" : null }, "example" : null }, "line_item_tiers" : { "type" : "array", "deprecated" : false, "description" : "The list of tiers applicable for this line item\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "line_item_id" : { "type" : "string", "deprecated" : false, "description" : "Uniquely identifies a line_item\n", "maxLength" : 40, "example" : null }, "starting_unit" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The lower limit of a range of units for the tier\n", "minimum" : 0, "example" : null }, "ending_unit" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The upper limit of a range of units for the tier\n", "example" : null }, "quantity_used" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of units purchased in a range.\n", "minimum" : 0, "example" : null }, "unit_amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* per_unit -Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The type of deduction and the amount to which it is applied.
\n* promotional_credits -The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The unique id of the line item that this deduction is for. Is required when discounts[entity_type]\nis item_level_coupon\nor document_level_coupon\n.
The type of deduction and the amount to which it is applied.
\n* item_level_discount -The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a promotional credit\napplied to the invoice.
", "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits", "item_level_discount", "document_level_discount" ], "example" : null }, "discount_type" : { "type" : "string", "deprecated" : false, "description" : "The type of discount that is applied to the line item. Relevant only when discounts[entity_type]\nis one of item_level_discount\n, item_level_coupon\n, document_level_discount\n, or document_level_coupon
when amount is applied as discount
\n* percentage -when percentage is applied as discount
", "enum" : [ "fixed_amount", "percentage" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the round_off_amount.\nIf there is no round-off amount\n, it will display 0\n.
The details of the line items in this invoice estimate.
\nNote
Line items that meet both the following conditions are not returned:
metered.line_item.amount is 0.Quantity of the recurring item\nwhich is represented by this line item. For metered\nline items, this value is updated from usages\nonce when the invoice is generated as pending\nand finally when the invoice is closed\n.
The decimal representation of the unit amount of the line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the amount for the line_item\n, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\n* export -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
If the Customer is marked as Tax exempt
\n* high_value_physical_goods -If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied
\n* zero_rated -If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
\n* tax_not_configured -If tax is not enabled for the site
\n* tax_not_configured_external_provider -If the tax is not configured for the country in 3rd party tax provider.
\n* region_non_taxable -If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction
\n* reverse_charge -If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
\n* product_exempt -If the Plan or Addon is marked as Tax exempt
\n* zero_value_item -If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.
", "enum" : [ "tax_not_configured", "region_non_taxable", "export", "customer_exempt", "product_exempt", "zero_rated", "reverse_charge", "high_value_physical_goods", "zero_value_item", "tax_not_configured_external_provider" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type\n", "maxLength" : 100, "example" : null }, "customer_id" : { "type" : "string", "deprecated" : false, "description" : "A unique identifier for the customer this line item belongs to\n", "maxLength" : 100, "example" : null } }, "required" : [ "date_from", "date_to", "description", "entity_type", "is_taxed", "unit_amount" ], "example" : null }, "example" : null }, "line_item_tiers" : { "type" : "array", "deprecated" : false, "description" : "The list of tiers applicable for this line item\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "line_item_id" : { "type" : "string", "deprecated" : false, "description" : "Uniquely identifies a line_item\n", "maxLength" : 40, "example" : null }, "starting_unit" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The lower limit of a range of units for the tier\n", "minimum" : 0, "example" : null }, "ending_unit" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The upper limit of a range of units for the tier\n", "example" : null }, "quantity_used" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of units purchased in a range.\n", "minimum" : 0, "example" : null }, "unit_amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* per_unit -Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The type of deduction and the amount to which it is applied.
\n* promotional_credits -The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The unique id of the line item that this deduction is for. Is required when discounts[entity_type]\nis item_level_coupon\nor document_level_coupon\n.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a promotional credit\napplied to the invoice.
\n* item_level_coupon -The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The type of discount that is applied to the line item. Relevant only when discounts[entity_type]\nis one of item_level_discount\n, item_level_coupon\n, document_level_discount\n, or document_level_coupon
when percentage is applied as discount
\n* fixed_amount -when amount is applied as discount
", "enum" : [ "fixed_amount", "percentage" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the round_off_amount.\nIf there is no round-off amount\n, it will display 0\n.
payment_schedule_estimate\nis used to hold the details related to payment schedules for an invoice. It will contain a list of payment_schedules\nresources.
The identifier of the payment_schedule_scheme\n, used to create the payment schedules.
The details of the line items in this invoice estimate.
\nNote
Line items that meet both the following conditions are not returned:
metered.line_item.amount is 0.Quantity of the recurring item\nwhich is represented by this line item. For metered\nline items, this value is updated from usages\nonce when the invoice is generated as pending\nand finally when the invoice is closed\n.
The decimal representation of the unit amount of the line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the amount for the line_item\n, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\n* zero_value_item -If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.
\n* tax_not_configured_external_provider -If the tax is not configured for the country in 3rd party tax provider.
\n* zero_rated -If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
\n* tax_not_configured -If tax is not enabled for the site
\n* high_value_physical_goods -If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied
\n* customer_exempt -If the Customer is marked as Tax exempt
\n* export -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
\n* region_non_taxable -If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction
\n* product_exempt -If the Plan or Addon is marked as Tax exempt
", "enum" : [ "tax_not_configured", "region_non_taxable", "export", "customer_exempt", "product_exempt", "zero_rated", "reverse_charge", "high_value_physical_goods", "zero_value_item", "tax_not_configured_external_provider" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type\n", "maxLength" : 100, "example" : null }, "customer_id" : { "type" : "string", "deprecated" : false, "description" : "A unique identifier for the customer this line item belongs to\n", "maxLength" : 100, "example" : null } }, "required" : [ "date_from", "date_to", "description", "entity_type", "is_taxed", "unit_amount" ], "example" : null }, "example" : null }, "line_item_tiers" : { "type" : "array", "deprecated" : false, "description" : "The list of tiers applicable for this line item\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "line_item_id" : { "type" : "string", "deprecated" : false, "description" : "Uniquely identifies a line_item\n", "maxLength" : 40, "example" : null }, "starting_unit" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The lower limit of a range of units for the tier\n", "minimum" : 0, "example" : null }, "ending_unit" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The upper limit of a range of units for the tier\n", "example" : null }, "quantity_used" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of units purchased in a range.\n", "minimum" : 0, "example" : null }, "unit_amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* per_unit -Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The type of deduction and the amount to which it is applied.
\n* item_level_coupon -The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The unique id of the line item that this deduction is for. Is required when discounts[entity_type]\nis item_level_coupon\nor document_level_coupon\n.
The type of deduction and the amount to which it is applied.
\n* item_level_discount -The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The type of discount that is applied to the line item. Relevant only when discounts[entity_type]\nis one of item_level_discount\n, item_level_coupon\n, document_level_discount\n, or document_level_coupon
when percentage is applied as discount
\n* fixed_amount -when amount is applied as discount
", "enum" : [ "fixed_amount", "percentage" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the round_off_amount.\nIf there is no round-off amount\n, it will display 0\n.
Quantity of the recurring item\nwhich is represented by this line item. For metered\nline items, this value is updated from usages\nonce when the invoice is generated as pending\nand finally when the invoice is closed\n.
The decimal representation of the unit amount of the line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the amount for the line_item\n, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\n* export -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
If tax is not enabled for the site
\n* zero_value_item -If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.
\n* product_exempt -If the Plan or Addon is marked as Tax exempt
\n* reverse_charge -If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
\n* customer_exempt -If the Customer is marked as Tax exempt
\n* zero_rated -If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
\n* tax_not_configured_external_provider -If the tax is not configured for the country in 3rd party tax provider.
\n* high_value_physical_goods -If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied
\n* region_non_taxable -If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction
", "enum" : [ "tax_not_configured", "region_non_taxable", "export", "customer_exempt", "product_exempt", "zero_rated", "reverse_charge", "high_value_physical_goods", "zero_value_item", "tax_not_configured_external_provider" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type\n", "maxLength" : 100, "example" : null }, "customer_id" : { "type" : "string", "deprecated" : false, "description" : "A unique identifier for the customer this line item belongs to\n", "maxLength" : 100, "example" : null } }, "required" : [ "date_from", "date_to", "description", "entity_type", "is_taxed", "unit_amount" ], "example" : null }, "example" : null }, "line_item_tiers" : { "type" : "array", "deprecated" : false, "description" : "The list of tiers applicable for this line item\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "line_item_id" : { "type" : "string", "deprecated" : false, "description" : "Uniquely identifies a line_item\n", "maxLength" : 40, "example" : null }, "starting_unit" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The lower limit of a range of units for the tier\n", "minimum" : 0, "example" : null }, "ending_unit" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The upper limit of a range of units for the tier\n", "example" : null }, "quantity_used" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of units purchased in a range.\n", "minimum" : 0, "example" : null }, "unit_amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* per_unit -Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The type of deduction and the amount to which it is applied.
\n* item_level_discount -The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The unique id of the line item that this deduction is for. Is required when discounts[entity_type]\nis item_level_coupon\nor document_level_coupon\n.
The type of deduction and the amount to which it is applied.
\n* document_level_discount -The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a promotional credit\napplied to the invoice.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The type of discount that is applied to the line item. Relevant only when discounts[entity_type]\nis one of item_level_discount\n, item_level_coupon\n, document_level_discount\n, or document_level_coupon
when percentage is applied as discount
\n* fixed_amount -when amount is applied as discount
", "enum" : [ "fixed_amount", "percentage" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the round_off_amount.\nIf there is no round-off amount\n, it will display 0\n.
The decimal representation of the amount for the charge, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
When important changes occur on your Chargebee site, they are recorded as events. An event contains data about the affected resources and metadata, such as the timestamp of the change. For example, when a subscription is canceled due to non-payment, an event such as subscription_cancelled is recorded.
If webhooks are configured in Chargebee, events trigger those webhooks. If multiple webhooks are configured, Chargebee calls each webhook sequentially for every event. If a webhook call fails or times out, it is retried based on a fixed schedule. The webhook call is an HTTP POST with the content type application/json.
Caution:\nWebhooks are asynchronous and are not recommended for time-critical applications. Webhooks may arrive out of order or be delivered multiple times. For time-sensitive use cases, use the List events API to poll Chargebee for events.
To mark a webhook notification successful, the webhook must return an HTTP status code in the 2XX range. If a 2XX response is not received, Chargebee retries the webhook call with increasing delays for up to 2 days. You can also resend webhook calls manually from the web console.\nDue to webhook retries, it is possible that your application receives the same webhook more than once. Detect such duplicates within your application to ensure the idempotency of the webhook call. This can be done by examining the id parameter since its value uniquely identifies an event.\nFor example, your application can do the following for each webhook notification:
id and keep it in a persistent store such as a relational database or redis.id is already processed.Webhooks can also arrive at your application out-of-order. This can be due to issues such as network delays or webhook failures. However, you can order the events by examining the resource_version attribute of the resource sent by the webhook. For every change made to the resource, resource_version is updated with a new timestamp in milliseconds.\nFor example, if you wish to sync resource changes from Chargebee to your application, you can:
rv1 of the resource_version attribute from the resource in the webhook.rv2 of resource_version from the resource stored on your side.rv1 > rv2, process the resource; otherwise, ignore.API Version\nChargebee supports multiple API versions now. The api_version attribute indicates the API version based on which the event content is structured. While processing webhooks, ensure that api_version is the same as the API version used by your webhook server's client library.
You can have basic authentication\nfor the webhook URL.
In addition to securing your webhook, you can ensure the integrity of the event data by fetching it again using the Retrieve an Event\nAPI call.
Webhooks from Chargebee originate from a specific set of IP addresses.
The "user" that triggered the event. The value depends on the source
source is admin_console: the email address of the user that triggered the event.source is api, js_api or bulk_operation: the name of the API key that was used to trigger the event.source is external_service: the name of the service that called our webhook. Eg. ADYEN, STRIPE, AMAZON_PAYMENTS etc.source is hosted_page or portal: the user attribute is not passed.The type of event provided by Chargebee. See event types\nfor a complete list.
\n* card_deleted -Sent when a card is deleted for a customer
\n* subscription_cancelled -Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as 'cancel_reason'.
\n* omnichannel_subscription_item_updated -Triggered when an omnichannel subscription item is updated.
\n* customer_changed -Sent when a customer is changed
\n* invoice_deleted -Event triggered when an invoice is deleted.
\n* omnichannel_subscription_item_changed -Triggered when an omnichannel subscription item is changed
\n* subscription_shipping_address_updated -Triggered when shipping address is added or updated for a subscription.
\n* differential_price_created -Triggered when a differential price is created
\n* subscription_created -Sent when a new subscription is created.
\n* payment_initiated -Sent when a payment is initiated via direct debit
\n* quote_updated -Triggered when quote is updated
\n* payment_source_added -Sent when a payment source is added for a customer.
\n* contract_term_created -Triggered when new contract term is created
\n* subscription_business_entity_changed -Sent when a subscription's business entity is changed.
\n* subscription_deleted -Sent when a subscription has been deleted
\n* differential_price_deleted -Triggered when a differential price is deleted
\n* omnichannel_subscription_created -Triggered when an omnichannel subscription is created
\n* voucher_created -Triggered when a payment voucher is created.
\n* subscription_ramp_drafted -Triggered when a subscription ramp is moved to draft status.
\n* transaction_deleted -Triggered when a transaction is deleted.
\n* item_family_deleted -Triggered when an item family is deleted
\n* product_updated -Triggered when the product update is completed successfully
\n* payment_failed -Sent when attempt to charge customer's credit card fails
\n* subscription_reactivated_with_backdating -Sent when the subscription is moved from cancelled state to active or in_trial state with past date
\n* omnichannel_subscription_item_cancellation_scheduled -Triggered when an omnichannel subscription item is scheduled for cancellation
\n* omnichannel_subscription_item_resumed -Triggered when an omnichannel subscription item is resumed
\n* payment_source_expiring -Sent when the customer's payment source is expiring soon. Sent 30 days before the expiry date.
\n* payment_schedules_created -Event triggered when new payment schedules are created for an invoice
\n* subscription_entitlements_updated -Triggered when subscription entitlements are updated for a subscription change.
\n* price_variant_updated -Triggered when a price variant is updated.
\n* omnichannel_subscription_item_dunning_expired -Triggered when an omnichannel subscription item's dunning has expired
\n* item_price_updated -Triggered when an item price is updated
\n* order_ready_to_process -Triggered when order reaches its order date
\n* entitlement_overrides_updated -Triggered when an override entitlement is updated
\n* item_updated -Triggered when an item is updated
\n* coupon_set_updated -Sent when a coupon set is changed
\n* subscription_reactivated -Sent when the subscription is moved from cancelled state to active or in_trial state
\n* variant_created -Triggered when product variant created successfully.
\n* addon_updated -Sent when an addon is changed.
\n* subscription_scheduled_changes_removed -Sent when scheduled change for the subscription is removed.
\n* customer_business_entity_changed -Sent when a customer's business entity is changed.
\n* payment_refunded -Sent when a payment refund is made
\n* subscription_started -Sent when a 'future' subscription gets started at the scheduled date.
\n* attached_item_created -Triggered when an Attached item is created
\n* token_created -Sent when a Token is created
\n* item_family_created -Triggered when an item family is created
\n* subscription_created_with_backdating -Sent when a new subscription is created with backdating.
\n* unbilled_charges_deleted -Triggered when unbilled charges are deleted.
\n* omnichannel_subscription_item_renewed -Triggered when an omnichannel subscription item is renewed
\n* subscription_ramp_applied -Triggered when a subscription ramp is applied.
\n* promotional_credits_added -Sent when promotional credits are added to a customer.
\n* subscription_canceled_with_backdating -Sent when the subscription gets cancelled. If cancelled due to non payment or card not present, the subscription will have the possible reason as 'cancel_reason'.
\n* item_entitlements_updated -Triggered when item entitlements are updated to a feature
\n* card_expired -Sent when a card for a customer is expired
\n* payment_intent_created -Sent when a Payment intent is created
\n* subscription_changed_with_backdating -Sent after the subscription's recurring items have been changed with backdated date
\n* subscription_scheduled_cancellation_removed -Sent when scheduled cancellation is removed for the subscription.
\n* omnichannel_subscription_item_resubscribed -Triggered when an omnichannel subscription item is resubscribed
\n* feature_updated -Triggered when an feature is updated
\n* payment_schedule_scheme_created -Event triggered when a new payment schedule scheme is created
\n* plan_deleted -Sent when a plan is deleted.
\n* omnichannel_subscription_imported -Triggered when an omnichannel subscription item is imported
\n* tax_withheld_refunded -Sent when a tax withheld refund is made
\n* unbilled_charges_voided -Triggered when unbilled charges are voided.
\n* customer_moved_out -Sent when a customer is copied to another site
\n* feature_created -Triggered when a feature is created.
\n* record_purchase_failed -Triggered when an omnichannel record purchase is failed
\n* coupon_codes_deleted -Sent when coupon codes are deleted in coupon set
\n* subscription_paused -Sent when the subscription is paused.
\n* order_updated -Triggered when order is updated
\n* subscription_movement_failed -Triggered when a subscription movement failed
\n* unbilled_charges_created -Triggered when unbilled charges are created.
\n* subscription_moved_in -Triggered when a subscription moved from other customer
\n* feature_archived -Triggered when a feature is archived.
\n* subscription_ramp_deleted -Triggered when a subscription ramp is deleted.
\n* payment_succeeded -Sent when the payment is successfully collected
\n* voucher_expired -Triggered when a payment voucher is expired.
\n* mrr_updated -Sent when either of MRR or CMRR of a subscription changes
\n* subscription_scheduled_resumption_removed -Triggered when scheduled resumption is removed for the subscription.
\n* subscription_changes_scheduled -Sent when subscription changes are scheduled for later. Changes will be applied at the end of current term.
\n* order_ready_to_ship -Triggered when order reaches its shipping date
\n* omnichannel_subscription_item_cancelled -Triggered when an omnichannel subscription item is cancelled
\n* purchase_created -Triggered when purchase action completed successfully
\n* variant_updated -Triggered when product variant updated successfully.
\n* variant_deleted -Triggered when product variant deleted successfully.
\n* subscription_trial_end_reminder -Sent when the customer's trial period is about to end.
\n* feature_activated -Triggered when a feature status transitions to active for the first time.
Sent when the subscription is renewed from the current term.
\n* plan_created -Sent when a plan is created.
\n* item_created -Triggered when an item is created
\n* coupon_codes_updated -Sent when coupon codes are updated
\n* gift_unclaimed -Triggered when a new gift is unclaimed and is ready to be claimed
\n* subscription_entitlements_created -Triggered when subscription entitlements are created for a new subscription
\n* subscription_ramp_updated -Triggered when a subscription ramp is updated.
\n* virtual_bank_account_added -Sent when a virtual bank account is added for a customer.
\n* subscription_moved_out -Triggered when a subscription moved to other customer
\n* contract_term_completed -Triggered when contract term is completed
\n* feature_deleted -Triggered when a feature is deleted
\n* subscription_renewal_reminder -Sent before each subscription's renewal based on plan's period
\n* coupon_updated -Sent when a coupon is changed.
\n* token_consumed -Sent when a Token is consumed
\n* omnichannel_subscription_item_upgraded -Triggered when an omnichannel subscription item is upgraded
\n* transaction_created -Triggered when a transaction is recorded
\n* invoice_installment_updated -Triggered when an installment\nstatus changes.
Event triggered when a payment schedule scheme is deleted
\n* customer_deleted -Sent when a customer is deleted
\n* installment_config_created -Triggered when an installment_config\nis created.
Sent when one or more Subscription Items are renewed
\n* coupon_deleted -Sent when a coupon is deleted.
\n* quote_deleted -Triggered when quote is deleted
\n* card_updated -Sent when the card is updated for a customer.
\n* coupon_created -Sent when a coupon is created.
\n* quote_created -Triggered when quote is created
\n* add_usages_reminder -Sent every month day before renewal date of plan's period
\n* business_entity_updated -Sent when a business entity is updated.
\n* subscription_changed -Sent after the subscription's recurring items have been changed
\n* customer_created -Sent when a new customer is created, either directly or automatically during subscription creation.
\n* price_variant_created -Triggered when a price variant is created.
\n* coupon_set_deleted -Sent when a coupon set is deleted
\n* refund_initiated -Sent when a refund is initiated via direct debit
\n* order_cancelled -Triggered when order is cancelled
\n* entitlement_overrides_removed -Triggered when an override entitlement is removed
\n* coupon_codes_added -Sent when coupon codes are added in coupon set
\n* omnichannel_subscription_item_paused -Triggered when an omnichannel subscription item is paused
\n* card_added -Sent when a card is added for a customer.
\n* gift_cancelled -Triggered when a gift is cancelled.
\n* omnichannel_subscription_item_downgrade_scheduled -Triggered when a downgrade for an omnichannel subscription item is scheduled.
\n* entitlement_overrides_auto_removed -Triggered when Subscription entitlements overrides for a feature are auto removed after expiry
\n* omnichannel_subscription_moved_in -Triggered when an omnichannel subscription is moved to another customer
\n* omnichannel_subscription_item_downgraded -Triggered when an omnichannel subscription item is downgraded
\n* payment_source_deleted -Sent when a payment source is deleted for a customer
\n* credit_note_created -Sent when a credit note is created
\n* subscription_resumption_scheduled -Triggered when the subscription resumption is scheduled.
\n* item_price_deleted -Triggered when an item price is deleted
\n* subscription_advance_invoice_schedule_updated -Triggered when scheduled advance invoice is updated for a subscription.
\n* item_deleted -Triggered when an item is deleted
\n* omnichannel_one_time_order_item_cancelled -Triggered when an omnichannel one time order item is cancelled
\n* gift_claimed -Triggered when a gift is claimed
\n* feature_reactivated -Triggered when a feature status transitions to active for the second time or more.
Sent after the subscription has been moved from trial to active state
\n* subscription_resumed -Sent when the subscription is moved from paused state to active state
\n* omnichannel_subscription_item_scheduled_downgrade_removed -Triggered when an omnichannel subscription item scheduled downgrade is removed
\n* credit_note_deleted -Sent when a credit note is deleted
\n* item_price_entitlements_removed -Triggered when item price entitlements are removed for a feature
\n* subscription_advance_invoice_schedule_added -Triggered when advance invoice is scheduled for a subscription.
\n* differential_price_updated -Triggered when a differential price is updated
\n* alert_status_changed -Triggered when an alert's runtime status for a subscription changes between IN_ALARM and WITHIN_LIMIT.\nThis indicates a change in the subscription's usage relative to the alert threshold and applies only to usage-based billing.
\n* order_deleted -Triggered when order is deleted
\n* omnichannel_subscription_item_scheduled_cancellation_removed -Triggered when an omnichannel subscription item scheduled cancellation is removed
\n* token_expired -Sent when a Token is expired
\n* price_variant_deleted -Triggered when a price variant is deleted.
\n* transaction_updated -Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.
\n* subscription_cancellation_reminder -Sent when the customer's subscription is nearing its scheduled cancellation date.
\n* product_deleted -Triggered when the product delete is completed successfully
\n* omnichannel_subscription_item_reactivated -Triggered when an omnichannel subscription item's refund is reversed
\n* invoice_generated -Event triggered when a new invoice is generated. In case of metered billing, this event is triggered when a "Pending" invoice is closed.
\n* order_delivered -Triggered when order is marked as delivered
\n* pending_invoice_created -Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled.
\n* subscription_ramp_created -Triggered when a subscription ramp is created.
\n* omnichannel_subscription_item_expired -Triggered when an omnichannel subscription item is expired
\n* authorization_succeeded -Triggered when an authorization transaction is created.
\n* invoice_generated_with_backdating -Event triggered when a new invoice is generated with past date as invoice date.
\n* omnichannel_subscription_item_change_scheduled -Triggered when an omnichannel subscription item change is scheduled
\n* subscription_cancellation_scheduled -Sent when subscription is scheduled to cancel at end of current term
\n* order_created -Triggered when order is created
\n* hierarchy_deleted -Triggered when a hierarchy is deleted
\n* subscription_activated_with_backdating -Sent after the subscription changes to active from another status, while the change is backdated.
Sent when a plan is changed.
\n* tax_withheld_recorded -Triggered when a tax withheld is recorded for an invoice
\n* invoice_installments_created -Triggered when installment\nresources are created for an invoice.
Sent when a credit note is created with past date as credit note date
\n* omnichannel_subscription_item_pause_scheduled -Triggered when an omnichannel subscription item scheduled for pause
\n* gift_updated -Triggered when a gift is updated
\n* order_resent -Triggered when order is resent
\n* hierarchy_created -Triggered when a hierarchy is created
\n* addon_deleted -Sent when an addon is deleted.
\n* voucher_create_failed -Triggered when a payment voucher creation fails.
\n* customer_moved_in -Sent when a customer is copied from another site
\n* customer_entitlements_updated -Triggered when entitlements for the list of customers got updated.
\n* item_price_entitlements_updated -Triggered when item Price entitlements are updated to a feature
\n* omnichannel_subscription_item_grace_period_expired -Triggered when an omnichannel subscription item's grace period has expired
\n* attached_item_deleted -Triggered when an Attached item is deleted
\n* unbilled_charges_invoiced -Triggered when unbilled charges are invoiced.
\n* subscription_pause_scheduled -Sent when the subscription is scheduled to pause.
\n* order_returned -Triggered when order is marked as returned
\n* payment_source_expired -Sent when a payment source for a customer is expired
\n* contract_term_terminated -Triggered when contract term is terminated
\n* product_created -Triggered when the product create is completed successfully
\n* payment_source_updated -Sent when the payment source is updated for a customer or when role is assigned to the payment source.
\n* pending_invoice_updated -Event triggered when the option "Notify and wait to close invoices" is enabled, and the 'Pending' invoice is updated.
\n* omnichannel_subscription_item_grace_period_started -Triggered when an omnichannel subscription item's grace period has started
\n* subscription_advance_invoice_schedule_removed -Triggered when scheduled advance invoice is removed for a subscription.
\n* tax_withheld_deleted -Triggered when a tax withheld is deleted
\n* omnichannel_subscription_item_dunning_started -Triggered when an omnichannel subscription item's dunning has started
\n* business_entity_created -Sent when a business entity is created.
\n* item_price_created -Triggered when an item price is created
\n* virtual_bank_account_updated -Sent when the virtual bank account is updated for a customer.
\n* credit_note_updated -Sent when a credit note is updated
\n* subscription_scheduled_pause_removed -Triggered when scheduled pause is removed for the subscription.
\n* card_expiry_reminder -Sent 30 days before the customer's credit card expires.
\n* coupon_set_created -Sent when a coupon set is created
\n* virtual_bank_account_deleted -Sent when a virtual bank account is deleted for a customer.
\n* omnichannel_one_time_order_created -Triggered when an omnichannel one time order is created
\n* gift_scheduled -Triggered when a new gift is created
\n* payment_schedules_updated -Event triggered when payment schedules are updated for an invoice
\n* business_entity_deleted -Sent when a business entity is deleted.
\n* omnichannel_subscription_item_recovered -Triggered when an omnichannel subscription item recovers from a billing issue and is active again.
\n* promotional_credits_deducted -Sent when a customer prmotion credits deducted
\n* installment_config_deleted -Triggered when an installment_config\nis deleted
Triggered when new contract term is renewed
\n* usage_file_ingested -Triggered when a usage_file\nis successfully ingested.
\n* subscription_trial_extended -Sent when a subscription trial is extended.
\n* item_entitlements_removed -Triggered when item entitlements are removed for a feature
\n* gift_expired -Triggered when a gift expires
\n* omnichannel_subscription_item_scheduled_change_removed -Triggered when an omnichannel subscription item scheduled change is removed
\n* contract_term_cancelled -Triggered when contract term is cancelled
\n* authorization_voided -Triggered when an authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time.
\n* item_family_updated -Triggered when an item family is updated
\n* addon_created -Sent when an addon is created.
\n* attached_item_updated -Triggered when an Attached item is updated
\n* invoice_updated -Triggered when the invoice's shipping/billing address is updated, if the invoice is voided, or when the amount due is modified due to payments applied/removed.
\n* payment_intent_updated -Sent when a Payment intent is updated
\n* payment_source_locally_deleted -Sent when a payment source for a customer removed from Chargebee
", "enum" : [ "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "payment_schedules_created", "payment_schedules_updated", "payment_schedule_scheme_created", "payment_schedule_scheme_deleted", "subscription_renewal_reminder", "add_usages_reminder", "payment_due_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "item_family_created", "item_family_updated", "item_family_deleted", "item_created", "item_updated", "item_deleted", "item_price_created", "item_price_updated", "item_price_deleted", "attached_item_created", "attached_item_updated", "attached_item_deleted", "differential_price_created", "differential_price_updated", "differential_price_deleted", "feature_created", "feature_updated", "feature_deleted", "feature_activated", "feature_reactivated", "feature_archived", "item_entitlements_updated", "entitlement_overrides_updated", "entitlement_overrides_removed", "item_entitlements_removed", "entitlement_overrides_auto_removed", "subscription_entitlements_created", "subscription_entitlements_updated", "business_entity_created", "business_entity_updated", "business_entity_deleted", "customer_business_entity_changed", "subscription_business_entity_changed", "purchase_created", "voucher_created", "voucher_expired", "voucher_create_failed", "item_price_entitlements_updated", "item_price_entitlements_removed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "price_variant_created", "price_variant_updated", "price_variant_deleted", "customer_entitlements_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "usage_file_ingested", "omnichannel_subscription_item_pause_scheduled", "omnichannel_subscription_moved_in", "omnichannel_transaction_created", "alert_status_changed", "omnichannel_subscription_item_updated", "omnichannel_subscription_item_recovered" ], "example" : null }, "api_version" : { "type" : "string", "default" : "v1", "deprecated" : false, "description" : "The Chargebee API version used to render this event content. When processing webhooks, ensure that this version matches the one used by your webhook server's client library.\n\\* v1 -\n\nChargebee API version V1\n\\* v2 -\n\nChargebee API version V2\n", "enum" : [ "v1", "v2" ], "example" : null }, "content" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "The JSON data associated with this event. Has resources (\\*subscription\\* , \\*invoice\\* etc) based on the \\[event type\\](/docs/api/events/event-types). These resources are structured based on the Chargebee API version indicated by the \\*api_version\\* attribute.\n", "example" : null }, "origin_user" : { "type" : "string", "deprecated" : false, "description" : "The email address of the user, if captured, in the API operation that triggered the event. This email address is captured through either the chargebee-request-origin-user or chargebee-request-origin-user-encoded custom HTTP request headers.
Note:\nApplicable only when event_source is api.
Array of webhook call statuses: one for each of the webhooks configured for the site. This object is only available after the first webhook call for the event has completed or timed out. Also, creation/updation of the webhook\nobject data is a queued operation and hence there can be an additional delay of up to 5 seconds.
webhooks object is unavailable on the first webhook call for the event. For subsequent calls, this attribute holds the status from after the last retry.Disabled as no longer used
\n* failed -Webhook call has been suspended after the all retries have resulted in failure.
\n* succeeded -Webhook call was successful.
\n* scheduled -Webhook call has been scheduled.
\n* re_scheduled -Webhook call has been rescheduled due failure(s) in previous call(s)
\n* not_applicable -Webhook call is not applicable for this event.
\n* skipped -Skipped as specified in request
\n* not_configured -Webhook was not configured when this event occurred
", "enum" : [ "not_configured", "scheduled", "succeeded", "re_scheduled", "failed", "skipped", "not_applicable", "disabled", "rate_limited" ], "example" : null } }, "required" : [ "id", "webhook_status" ], "example" : null }, "example" : null } }, "required" : [ "content", "id", "occurred_at", "source" ], "example" : null }, "EventName" : { "type" : "string", "deprecated" : false, "enum" : [ "cancellation_page_loaded" ], "example" : null }, "EventType" : { "type" : "string", "deprecated" : false, "enum" : [ "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "payment_schedules_created", "payment_schedules_updated", "payment_schedule_scheme_created", "payment_schedule_scheme_deleted", "subscription_renewal_reminder", "add_usages_reminder", "payment_due_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "item_family_created", "item_family_updated", "item_family_deleted", "item_created", "item_updated", "item_deleted", "item_price_created", "item_price_updated", "item_price_deleted", "attached_item_created", "attached_item_updated", "attached_item_deleted", "differential_price_created", "differential_price_updated", "differential_price_deleted", "feature_created", "feature_updated", "feature_deleted", "feature_activated", "feature_reactivated", "feature_archived", "item_entitlements_updated", "entitlement_overrides_updated", "entitlement_overrides_removed", "item_entitlements_removed", "entitlement_overrides_auto_removed", "subscription_entitlements_created", "subscription_entitlements_updated", "business_entity_created", "business_entity_updated", "business_entity_deleted", "customer_business_entity_changed", "subscription_business_entity_changed", "purchase_created", "voucher_created", "voucher_expired", "voucher_create_failed", "item_price_entitlements_updated", "item_price_entitlements_removed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "price_variant_created", "price_variant_updated", "price_variant_deleted", "customer_entitlements_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "usage_file_ingested", "omnichannel_subscription_item_pause_scheduled", "omnichannel_subscription_moved_in", "omnichannel_transaction_created", "alert_status_changed", "omnichannel_subscription_item_updated", "omnichannel_subscription_item_recovered" ], "example" : null }, "ExcludeTaxType" : { "type" : "string", "default" : "none", "deprecated" : false, "enum" : [ "exclusive", "none" ], "example" : null }, "Export" : { "type" : "object", "description" : "Export resource represents an export job and contains the status of the job and the download URL, if the job is successfully completed.\n\nExport operations are asynchronous and will return \"Export\" resource in response . The export resource will contain the status of the export job (like in-process, completed...) . If the status is completed, it will contain the download url pointing to the zip/pdf containing the exported data.\n\n**Note:** At any given point, only 5 export jobs can be processed. Beyond that, an error stating that the API request limit has been reached will be returned.\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "A unique identifier to identify the export\n", "maxLength" : 50, "example" : null }, "operation_type" : { "type" : "string", "deprecated" : false, "description" : "Describes the type of export\n", "maxLength" : 100, "example" : null }, "mime_type" : { "type" : "string", "default" : "zip", "deprecated" : false, "description" : "Describes the mime type of download file\n\\* pdf -\n\nPDF\n\\* zip -\n\nZIP\n", "enum" : [ "pdf", "zip" ], "example" : null }, "status" : { "type" : "string", "default" : "in_process", "deprecated" : false, "description" : "Current status of the export operation\n\\* completed -\n\nCompleted\n\\* failed -\n\nFailed\n\\* in_process -\n\nIn Process\n", "enum" : [ "in_process", "completed", "failed" ], "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Export created time\n", "example" : null }, "download" : { "type" : "object", "deprecated" : false, "description" : "Returns the download_url for the export. The download URL is valid upto a specific date.\n", "properties" : { "download_url" : { "type" : "string", "deprecated" : false, "description" : "The URL at which the file is available for download.\n", "maxLength" : 3500, "example" : null }, "valid_till" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time until which the download_url\nis valid.
A unique and immutable identifier for the feature. You can set it yourself, in which case it is recommended that a human-readable format (or slug) be used. For example, number-of-users-ccjht01.\nWhen not provided, a random value is automatically set.
A case-sensitive unique name for the feature. For example: user license\n, data storage\n, Salesforce Integration\n, devices\n, UHD Streaming\n, and so on.
Note:\nThis name is not displayed on any customer-facing documents or pages such as invoice PDFs\nor hosted pages.\nHowever, in the future, it is likely to be introduced on the Self-Serve Portal\n.
", "maxLength" : 50, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "description" : "A brief description of the feature. For example: Access to 10TB cloud storage\n.
The current status of the feature.
\n* active -A draft\nor an archived\nfeature can be changed to active.\nAny entitlements\nor subscription entitlements\ndefined for the feature take effect immediately.
The feature is in an unpublished state. Entitlements\nand subscription entitlements\ncan be created for a draft feature but they are not effective until the feature is active. A feature status\ncannot be changed back to draft\nonce it is in active\nor archived\nstatus\n.
An active\nfeature can be changed to archived.\nOnce archived\n, no new\nentitlements\nor subscription entitlements\ncan be created for the feature. However, any pre-existing item or subscription entitlements from the time that the feature was active\n, remain effective.
The type of feature.
\n* quantity -The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with name\nsuch as number of users\ncan have entitlement levels of say, 5\n, 20\n, 50\n, and 100.\nlevels[is_unlimited]\nis used for specifying the "unlimited" entitlement level.
The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as number of users\ncan have entitlement levels starting at 5\nusers and go up to 50000.\nlevels[is_unlimited]\nis used for specifying the "unlimited" entitlement level.
A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.
\n* custom -The entitlement levels available for this feature are defined as a set of custom values. For example, a feature Email Support\ncan have entitlement levels as 24×7\nand 24×5\n.
For features of type\nquantity\nor range\n, this specifies the unit of measure. The value is expected in the singular form and when used by the system, it is pluralized automatically as needed. For example, for a feature such as user licenses\n, the unit\ncan be license\n.
The version number of this resource. For every change made to the resource, resource_version\nis updated with a new timestamp in milliseconds.
The version number of this resource. For every change made to the resource, resource_version\nis updated with a new timestamp in milliseconds.
An ordered list of entitlement levels available for the feature. This is only applicable when type\nis other than switch\n.\nNote:\nWhen the type\nof the feature is switch\n, this is not applicable. This is because any given entity can be either fully entitled to a switch\nfeature or not entitled at all; there are no intermediate entitlement levels.
A case-sensitive display name for the entitlement level. Provide a name that helps you clearly identify the entitlement level. For example: a feature such as Email Support\ncan have entitlement levels named as All weekdays\n, All days\n, 40 hours per week\nand so on.
When not provided for feature.type\nquantity\nor range\n, this name is auto-generated as the space-separated concatenation of levels[].value\nand the pluralized version of unit.\nFor example, if levels[].value\nis 20\nand unit\nis user\n, then levels[].name\nbecomes 20 users\n.
The value denoting the entitlement level granted.
\ntype is quantity: this attribute denotes the quantity of units of the feature for this entitlement level. For example, a feature such as number of users can have levels[].value as 5, 20, 50, and 100. levels[].is_unlimited is used to set the entitlement level to "unlimited".type is range: there can be be only two elements in the levels[] array; one corresponding to the minimum value (levels[0]) and the other to the maximum value (levels[1]) of the range of possible entitlement levels. For example, a feature such as number of users may have levels[0].value = 5 and levels[1].value = 50000. When the upper limit is "unlimited", then levels[1].value is not set and levels[1].is_unlimited is true.type is custom: this attribute denotes the value of this custom entitlement level. For example, a feature Email Support can have levels[].value as one of say, 24×7 and 24×5.This attribute represents the order of the entitlement levels from lowest to highest.
\ntype is quantity or custom: The lowest entitlement level has the value 0, the next higher level has the value 1, followed by 2, and so on.type is range: This attribute is 0 for the minimum value and 1 for the maximum value in the range.When not defined, it is assumed as the index of the levels[]\narray.
When type\nis quantity\nor range\n, this attribute indicates whether the entitlement level corresponds to unlimited units of the feature. Possible values:
true: The entitlement level corresponds to unlimited units of the feature. levels[].value is ignored for this level. This can only be set for the level that has the highest value for levels[].level.false: The entitlement level does not correspond to unlimited units of the feature.One row of the filter_conditions composite on a global alert. It limits which subscriptions the alert applies to. When creating an alert, pass parallel arrays filter_conditions[field][], filter_conditions[operator][], and filter_conditions[value][]; values at the same index define one condition.
Subscription attribute to filter on. The API allows only plan_price_id (request parameter filter_conditions[field][]).
Compares against the subscription’s plan price identifier.
", "enum" : [ "plan_price_id" ], "example" : null }, "operator" : { "type" : "string", "deprecated" : false, "description" : "How field is compared to value (filter_conditions[operator][]).
The plan price attribute must equal this condition’s value.
The plan price attribute must not equal this condition’s value.
Operand for the operator, typically a plan price identifier. String, up to 50 characters (filter_conditions[value][]).
The time until which the download_url\nis valid.
An advice code from the payment gateway or network that indicates how to handle a card decline. For example, the value try_again_later means you can retry the transaction.
When true\n, the claim happens automatically. When not passed, the default value in the site settings is used.
When true\n, indicates that the gift does not expire. Do not pass or pass as false\nwhen auto_claim\nis set.
The date until which the gift can be claimed. Must be set to a value after scheduled_at.\nIf the gift is not claimed within claim_expiry_date\n, it will expire and the subscription will move to cancelled\nstate. When not passed, the value specified in the site settings will be used.\nPass as NULL\nor do not pass when auto_claim\nor no_expiry\nare set.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
When a customer belongs to an account hierarchy, the hierarchy resource represents the customer's position within that hierarchy. The hierarchy provides details about the customer's parent, children, invoice owner, and payment owner.
Note
Related Endpoints
The id\nof the customer associated with this hierarchy\nresource.
The id\nof the immediate parent for the customer identified by customer_id.\nIf the customer is the root of the hierarchy, this attribute isn't returned.
The id\nof the customer responsible for paying the invoices for the customer identified by customer_id.\nThis ID must match either customer_id\nor invoice_owner_id\n.
The id\nof the customer who receives the invoice for charges incurred by the customer identified by customer_id.\nThis ID must match either customer_id\nor one of its ancestors.
A list of id\ns representing the immediate children, if any exist, for the customer identified by customer_id\n.
Hosted pages are the easiest way to integrate Chargebee with your website. For card payment methods, they help meet most of your PCI DSS compliance requirements. Chargebee offers hosted pages where your customers can perform the following actions:
redirect_url\nwith the hosted page id\nand state\npassed as query string parameters. As soon as the redirection happens, retrieve the hosted page\nto get details of the customer, subscription, invoice etc.This attribute allows you to store custom information with the hosted_page object. You can use it to associate specific data with a hosted page session.\nFor example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the redirect URL's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
The date and time when the hosted page URL expires. After this timestamp, the page can no longer be accessed.
\nThe expiration period depends on the type of hosted page:
checkout_new, checkout_existing, and checkout_one_time, the URL expires 3 hours after the page is created.collect_now and manage_payment_sources, the URL expires 5 days after creation.The version number of this resource. For every change made to the resource, resource_version\nis updated with a new timestamp in milliseconds.
The unique ID of the business entity\nof this hosted_page.
The list of items that have been impacted. The objects in this array have the following keys:
\nid: (string, max chars = 100) The unique identifier for the item.type: (enumerated string) The type of the item.This list can contain a maximum of 1,000 items. The full list of items is available in download.
The download\nresource containing all the impacted items. The list of items is available as a JSON array in the file at download.url\nuntil download.valid_till\n.
The time until which the download_url\nis valid.
When certain events in Chargebee cause changes to subscription entitlements, the impacted_subscriptions resource indicates the affected subscriptions. This resource is part of the content attribute of the triggered webhook for the following events:
feature is created, activated, or deleted.item_entitlement is updated or removed.entitlement_override is updated, removed, or auto-removed.Note
impacted_subscriptions through the API. Only webhooks send you this resource.The impacted subscription IDs. This list contains up to 1,000 IDs. The complete list of subscription IDs is in the download\nresource, which can store up to 100,000 IDs.
This download resource contains the impacted subscription IDs. These IDs are in a JSON array in the file at download.url until download.valid_till. The file at this URL stores up to 100,000 subscription IDs. Contact Support to increase this limit for your Chargebee site.
The expiration time for the download_url\n.
The id\nof the subscription\nfor which the receipt was sent.
The id\nof the customer\nobject to which the subscription belongs.
The\nid\nof the plan-item price of the subscription.
The id\nof the invoice generated in Chargebee
An invoice is a commercial document representing a sale of products/services offered by you to a customer. It enumerates all the charges, adjustments, payments, discounts and taxes associated with the sale.
An invoice is said to be a recurring one when it is has at least one charge for a plan or an addon item price. It is a non-recurring one when it has charges for only charge-item prices or one-time charges.
The item prices for any given billing term of a subscription are billed via an invoice at the beginning of the term (unless the charges are left unbilled). However, item prices that belong to metered items are billed at the end of the term via a pending invoice that can close automatically or via an API call. Moreover, when there are no metered items in the subscription, the invoices can still be generated as pending while creating or updating a subscription.
If auto-collection is enabled, then immediately on invoice generation (or, in case of subscriptions that have create_pending_invoices as true, on invoice closure), the payment method on file is charged:
paid.payment_due and dunning settings are taken into account for payment retries.not_paid.paid and the balance, if any, is added to excess payments for the customer.Note: If consolidated invoicing is enabled, the attribute subscription_id is unavailable when the invoice has line items from multiple subscriptions. The individual subscription ids are seen under line_items.subscription_id.
A recurring invoice contains at least one line item that is billed on a recurring basis. Specifically, it has at least one line_items[] with entity_type set to plan_item_price or addon_item_price. A non-recurring invoice contains no recurring line items.
The refundable amount for an invoice is the (amount paid on the invoice + refundable credit applied on the invoice + taxes withheld on the invoice) minus (amount issued as refundable credit notes from the invoice). Each of these amounts is obtained from the invoice resource as follows:
amount_paidcredits_appliedlinked_taxes_withheld[].amountissued_credit_notes[i].cn_total where issued_credit_notes[i].cn_status is refunded or refund_due.The identifier of the subscription this invoice belongs to.\nNote:\nWhen consolidated invoicing is enabled, you have to refer to line_item`s\nsubscription_id\nto identify the subscriptions associated with this invoice. However, it is important to avoid using this attribute if the invoice includes charges from multiple subscriptions, as it will be null in such cases.
Current status of this invoice.
\n* paid -Indicates a paid invoice.
\n* posted -Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
\n* pending -The invoice is yet to be closed (sent for payment collection). An invoice is generated with this status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.\nThe invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.
Indicates the payment is not yet collected and is being retried as per retry settings.
\n* not_paid -Indicates the payment is not made and all attempts to collect is failed.
\n* voided -Indicates a voided invoice.
", "enum" : [ "paid", "posted", "payment_due", "not_paid", "voided", "pending" ], "example" : null }, "date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The document date displayed on the invoice PDF. By default, it has the same value as the effective date of the action that created the invoice (subscription creation, update, or invoice creation). This date can be backdated (set to a value in the past) while performing the actions. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription or non-recurring charge is effective as of a past date. However, if the invoice is created as pending\n, and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date.
The number of days from invoice.date until payment for the invoice is due.
The sum of all the line item amounts minus the sum of all line item discounts. In other words, this is the sum of all line_items[].amount
line_item_discounts[].discount_amount.The unpaid amount that is due on the invoice. This is calculated as: total
amount_paid\napplied_credits.applied_amountadjustment_credit_notes.cn_totallinked_taxes_withheld.amount.Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.
The version number of this resource. For every change made to the resource, resource_version\nis updated with a new timestamp in milliseconds.
This attribute is returned only if additional resources are available. Use this value as the input parameter for line_items_offset to retrieve the next set of resources.
Note:
The share of the invoice total due to new sales. When first_invoice\nis true\n, this attribute is the same as total. However, when the invoice is a consolidated\none, then it is the sum of all line_items.amount\nbelonging to a new.
The date when the invoice is finalized. This is the date in the invoice lifecycle when its status\nbecomes any one of the following for the first time: payment_due\n, posted\n, or paid.\nFor an invoice with status\nas pending\n, this happens when it gets closed.
Payments that are yet to be collected for the invoice. This is determined as amount_due - the sum of all linked_payments[txn_amount][i] where linked_payments[txn_status][i] is in_progress.
Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the round_off_amount.\nIf there is no round-off amount\n, it will display 0\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The decimal representation of the unit amount of the line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the amount for the line_item\n, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\n* tax_not_configured -If tax is not enabled for the site
\n* tax_not_configured_external_provider -If the tax is not configured for the country in 3rd party tax provider.
\n* customer_exempt -If the Customer is marked as Tax exempt
\n* region_non_taxable -If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction
\n* product_exempt -If the Plan or Addon is marked as Tax exempt
\n* zero_value_item -If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.
\n* reverse_charge -If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
\n* high_value_physical_goods -If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied
\n* zero_rated -If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
\n* export -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* per_unit -Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The unique id of the line item that this deduction is for. Is required when discounts[entity_type]\nis item_level_coupon\nor document_level_coupon\n.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a promotional credit\napplied to the invoice.
\n* document_level_discount -The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The type of discount that is applied to the line item. Relevant only when discounts[entity_type]\nis one of item_level_discount\n, item_level_coupon\n, document_level_discount\n, or document_level_coupon
when percentage is applied as discount
\n* fixed_amount -when amount is applied as discount
", "enum" : [ "fixed_amount", "percentage" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
Details of tax_withheld\nagainst this invoice.
An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_.\nFor example, tax_wh_16BdDXSlbu4uV1Ee6\n.
The status of this transaction.
\n* timeout -Transaction failed because of Gateway not accepting the connection.
\n* late_failure -Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.
\n* failure -Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure
\n* in_progress -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.
\n* success -The transaction is successful.
\n* voided -The transaction got voided or authorization expired at gateway.
\n* needs_attention -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
The status of the transaction.
\n* timeout -The transaction failed because the gateway did not accept the connection.
\n* success -The transaction was successful.
\n* in_progress -The transaction is being processed by the gateway. This typically occurs for direct debit transactions\nor, for cards, refund transactions. Processing can take 2-7 days, depending on the gateway and payment method.
\n* needs_attention -The transaction could not be completed because the connection with the gateway was terminated unexpectedly. For some gateways, Chargebee automatically reconciles such transactions. For others, you must manually reconcile them by using the Reconcile transaction API.\nUse this API to update the id_at_gateway\n(gateway transaction ID) and status.
Learn more\nabout needs_attention\ntransactions.
A payment that was previously marked as successful has failed due to a late failure notification from the gateway. This can happen if the account had insufficient funds or was closed after the initial authorization.
\n* voided -The transaction was voided, or the authorization expired at the gateway.
\n* failure -The transaction failed. Refer to the error_code\nand error_text\nfields for details about the failure.
The type of transaction.
\n* authorization -The transaction is an authorization to capture the amount\nfrom the customer's payment_source\n.
The transaction is a refund that returns the amount\nto the customer's payment_source\n.
The transaction is a payment that captures the amount\nfrom the customer's payment_source\n.
The transaction is a reversal of a previously captured payment.
", "enum" : [ "authorization", "payment", "refund", "payment_reversal" ], "example" : null }, "amount_capturable" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "This is the part of the authorized amount\nthat is yet to be captured. The payment capture is recorded as a transaction of type\n= payment.\nApplicable only for a transaction of type\n= authorization\n.
Type of reason for the authorization transaction.
\n* verification -The transaction was created to verify the payment method.
\n* blocking_funds -The transaction was created to block funds from the payment method.
\n* scheduled_capture -The transaction was authorized in advance for capture at a later time by a scheduled system job. The capture may succeed or fail, and its outcome is recorded as a linked transaction under linked_payments\n.
The status of this transaction.
\n* success -The transaction is successful.
\n* needs_attention -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure
\n* voided -The transaction got voided or authorization expired at gateway.
\n* in_progress -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.
\n* timeout -Transaction failed because of Gateway not accepting the connection.
\n* late_failure -Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.
", "enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ], "example" : null }, "txn_amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Total amount of the transaction\n", "minimum" : 0, "example" : null }, "retry_engine" : { "type" : "string", "default" : "chargebee", "deprecated" : false, "description" : "The payment retry system used for this dunning attempt.\n\\* chargebee -\n\nThe attempt was processed by Chargebee Recovery.\n\\* success_plus -\n\nThe attempt was processed by GoCardless Success Plus.\n\\* flexpay -\n\nThe attempt was processed by FlexPay Recovery.\n", "enum" : [ "chargebee", "flexpay", "successplus" ], "example" : null } }, "required" : [ "attempt", "dunning_type" ], "example" : null }, "example" : null }, "applied_credits" : { "type" : "array", "deprecated" : false, "description" : "Refundable Credits applied on this invoice.\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "cn_id" : { "type" : "string", "deprecated" : false, "description" : "Credit applied on the credit note ID.\n", "maxLength" : 50, "example" : null }, "applied_amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Total credit amount applied to this invoice.\n", "minimum" : 0, "example" : null }, "applied_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp when the credit amount was applied to this invoice.\n", "example" : null }, "cn_reason_code" : { "type" : "string", "deprecated" : false, "description" : "Credit note reason code. Deprecated; use the cn_create_reason_code parameter instead\n\\* other -\n\nCan be set when none of the above reason codes are applicable\n\\* order_cancellation -\n\nOrder Cancellation\n\\* product_unsatisfactory -\n\nProduct Unsatisfactory\n\\* chargeback -\n\nCan be set when you are recording your customer Chargebacks\n\\* subscription_cancellation -\n\nThis reason will be set automatically for Credit Notes created during cancel subscription operation\n\\* fraudulent -\n\nFRAUDULENT\n\\* subscription_pause -\n\nThis reason will be automatically set to credit notes created during pause/resume subscription operation.\n\\* service_unsatisfactory -\n\nService Unsatisfactory\n\\* subscription_change -\n\nThis reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\nis enabled\n\\* write_off -\n\nThis reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)\noperation.\n\\* order_change -\n\nOrder Change\n\\* waiver -\n\nWaiver\n", "enum" : [ "write_off", "subscription_change", "subscription_cancellation", "subscription_pause", "chargeback", "product_unsatisfactory", "service_unsatisfactory", "order_change", "order_cancellation", "waiver", "other", "fraudulent" ], "example" : null }, "cn_create_reason_code" : { "type" : "string", "deprecated" : false, "description" : "Credit note reason code\n", "maxLength" : 100, "example" : null }, "cn_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates the date at which this credit note is created\n", "example" : null }, "cn_status" : { "type" : "string", "deprecated" : false, "description" : "Credit note status.\n\\* voided -\n\nWhen the Credit Note has been cancelled.\n\\* adjusted -\n\nWhen the Credit Note has been adjusted against an invoice.\n\\* refund_due -\n\nWhen the credits are yet to be used, or have been partially used.\n\\* refunded -\n\nWhen the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n", "enum" : [ "adjusted", "refunded", "refund_due", "voided" ], "example" : null }, "tax_application" : { "type" : "string", "deprecated" : false, "description" : "Specifies how tax is handled for credits applied to this invoice.\n\\* pre_tax -\n\nCredits are applied before tax calculation.\n\\* post_tax -\n\nCredits are applied after tax calculation.\n", "enum" : [ "pre_tax", "post_tax" ], "example" : null } }, "required" : [ "applied_amount", "applied_at", "cn_id", "cn_status" ], "example" : null }, "example" : null }, "adjustment_credit_notes" : { "type" : "array", "deprecated" : false, "description" : "Adjustments created for this invoice\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "cn_id" : { "type" : "string", "deprecated" : false, "description" : "Credit-note id\n", "maxLength" : 50, "example" : null }, "cn_reason_code" : { "type" : "string", "deprecated" : false, "description" : "Credit note reason code. Deprecated; use the cn_create_reason_code parameter instead\n\\* subscription_cancellation -\n\nThis reason will be set automatically for Credit Notes created during cancel subscription operation\n\\* waiver -\n\nWaiver\n\\* write_off -\n\nThis reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)\noperation.\n\\* service_unsatisfactory -\n\nService Unsatisfactory\n\\* fraudulent -\n\nFRAUDULENT\n\\* product_unsatisfactory -\n\nProduct Unsatisfactory\n\\* order_change -\n\nOrder Change\n\\* subscription_change -\n\nThis reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\nis enabled\n\\* order_cancellation -\n\nOrder Cancellation\n\\* other -\n\nCan be set when none of the above reason codes are applicable\n\\* chargeback -\n\nCan be set when you are recording your customer Chargebacks\n\\* subscription_pause -\n\nThis reason will be automatically set to credit notes created during pause/resume subscription operation.\n", "enum" : [ "write_off", "subscription_change", "subscription_cancellation", "subscription_pause", "chargeback", "product_unsatisfactory", "service_unsatisfactory", "order_change", "order_cancellation", "waiver", "other", "fraudulent" ], "example" : null }, "cn_create_reason_code" : { "type" : "string", "deprecated" : false, "description" : "Credit note reason code\n", "maxLength" : 100, "example" : null }, "cn_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates the date at which this credit note is created\n", "example" : null }, "cn_total" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "Total amount of the credit note.\n", "minimum" : 0, "example" : null }, "cn_status" : { "type" : "string", "deprecated" : false, "description" : "Credit note status.\n\\* refunded -\n\nWhen the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n\\* voided -\n\nWhen the Credit Note has been cancelled.\n\\* refund_due -\n\nWhen the credits are yet to be used, or have been partially used.\n\\* adjusted -\n\nWhen the Credit Note has been adjusted against an invoice.\n", "enum" : [ "adjusted", "refunded", "refund_due", "voided" ], "example" : null } }, "required" : [ "cn_id", "cn_status" ], "example" : null }, "example" : null }, "issued_credit_notes" : { "type" : "array", "deprecated" : false, "description" : "Credit notes issued for this invoice\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "cn_id" : { "type" : "string", "deprecated" : false, "description" : "Credit-note id\n", "maxLength" : 50, "example" : null }, "cn_reason_code" : { "type" : "string", "deprecated" : false, "description" : "Credit note reason code. Deprecated; use the cn_create_reason_code parameter instead\n\\* fraudulent -\n\nFRAUDULENT\n\\* chargeback -\n\nCan be set when you are recording your customer Chargebacks\n\\* subscription_pause -\n\nThis reason will be automatically set to credit notes created during pause/resume subscription operation.\n\\* order_change -\n\nOrder Change\n\\* subscription_change -\n\nThis reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\nis enabled\n\\* product_unsatisfactory -\n\nProduct Unsatisfactory\n\\* write_off -\n\nThis reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)\noperation.\n\\* subscription_cancellation -\n\nThis reason will be set automatically for Credit Notes created during cancel subscription operation\n\\* service_unsatisfactory -\n\nService Unsatisfactory\n\\* waiver -\n\nWaiver\n\\* order_cancellation -\n\nOrder Cancellation\n\\* other -\n\nCan be set when none of the above reason codes are applicable\n", "enum" : [ "write_off", "subscription_change", "subscription_cancellation", "subscription_pause", "chargeback", "product_unsatisfactory", "service_unsatisfactory", "order_change", "order_cancellation", "waiver", "other", "fraudulent" ], "example" : null }, "cn_create_reason_code" : { "type" : "string", "deprecated" : false, "description" : "Credit note reason code\n", "maxLength" : 100, "example" : null }, "cn_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates the date at which this credit note is created\n", "example" : null }, "cn_total" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "Total amount of the credit note.\n", "minimum" : 0, "example" : null }, "cn_status" : { "type" : "string", "deprecated" : false, "description" : "Credit note status.\n\\* refund_due -\n\nWhen the credits are yet to be used, or have been partially used.\n\\* adjusted -\n\nWhen the Credit Note has been adjusted against an invoice.\n\\* voided -\n\nWhen the Credit Note has been cancelled.\n\\* refunded -\n\nWhen the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n", "enum" : [ "adjusted", "refunded", "refund_due", "voided" ], "example" : null } }, "required" : [ "cn_id", "cn_status" ], "example" : null }, "example" : null }, "linked_orders" : { "type" : "array", "deprecated" : false, "description" : "The list of orders for this invoice\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Uniquely identifies the order. It is the api identifier for the order\n", "maxLength" : 40, "example" : null }, "document_number" : { "type" : "string", "deprecated" : false, "description" : "The order's serial number\n", "maxLength" : 50, "example" : null }, "status" : { "type" : "string", "default" : "new", "deprecated" : false, "description" : "The status of this order.\n\\* awaiting_shipment -\n\nThe order has been picked up by an integration system, and synced to a shipping management platform\n\\* queued -\n\nOrder is yet to be processed by any system, these are scheduled orders created by Chargebee\n\\* returned -\n\nThe order has been returned after delivery.\n\\* complete -\n\nOrder has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n\\* processing -\n\nOrder is being processed. Applicable only if you are using Chargebee's legacy order management system\n\\* new -\n\nOrder has been created. Applicable only if you are using Chargebee's legacy order management system.\n\\* shipped -\n\nThe order has moved from order management system to a shipping system.\n\\* on_hold -\n\nThe order is paused from being processed.\n\\* cancelled -\n\nOrder has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n\\* delivered -\n\nThe order has been delivered to the customer.\n\\* partially_delivered -\n\nThe order has been partially delivered to the customer.\n\\* voided -\n\nOrder has been voided. Applicable only if you are using Chargebee's legacy order management system\n", "enum" : [ "new", "processing", "complete", "cancelled", "voided", "queued", "awaiting_shipment", "on_hold", "delivered", "shipped", "partially_delivered", "returned" ], "example" : null }, "order_type" : { "type" : "string", "deprecated" : false, "description" : "Order type\n\\* system_generated -\n\nThe order has been created by Chargebee automatically based on the preferences set by the user.\n\\* manual -\n\nThe order has been created by the user using Chargebee's legacy order management system.\n", "enum" : [ "manual", "system_generated" ], "example" : null }, "reference_id" : { "type" : "string", "deprecated" : false, "description" : "Reference id can be used to map the orders in the shipping/order management application to the orders in ChargeBee. The reference_id generally is same as the order id in the third party application.\n", "maxLength" : 50, "example" : null }, "fulfillment_status" : { "type" : "string", "deprecated" : false, "description" : "The fulfillment status of an order as reflected in the shipping/order management application. Typical statuses include Shipped,Awaiting Shipment,Not fulfilled etc;\n", "maxLength" : 50, "example" : null }, "batch_id" : { "type" : "string", "deprecated" : false, "description" : "Unique id to identify a group of orders.\n", "maxLength" : 50, "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The time at which the order was created\n", "example" : null } }, "required" : [ "created_at", "id" ], "example" : null }, "example" : null }, "notes" : { "type" : "array", "deprecated" : false, "description" : "The list of notes\nthat appear on the invoice PDF sent to the customer. Notes that come from a specific resource related to the invoice have entity_type\nand entity_id\ndefined. There can be up to two notes in this array for which entity_type\nand entity_id\nare not defined:
invoice_note parameter for various endpoints in the API that also create invoices. For example, creating a subscription, creating an invoice, and closing a pending invoice.The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The unique id\nfor the e-invoice. This is auto-generated by Chargebee.
The status of processing the e-invoice. To obtain detailed information about the current status\n, see message\n.
The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.
\n* rejected -The e-invoice was sent and it was rejected by the receiving entity due to some reason. The sending entity shall also reject the e-invoice.
\n* paid -The receiving entity has confirmed that the e-invoice has been paid.
\n* skipped -The e-invoice was not sent. This could be due to missing information or because the entity_identifier\nis not registered on the e-invoicing network.
The e-invoice was sent and there was an error due to which it was not delivered.
\n* in_progress -The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.
\n* message_acknowledgement -An acknowledgment confirming that the application response was successfully received by the receiving entity.
\n* scheduled -Sending the e-invoice to the customer has been scheduled.
\n* conditionally_accepted -The e-invoice has been accepted with conditions.
\n* accepted -The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.
\n* success -The e-invoice has been successfully delivered to the customer.
\n* in_process -The e-invoice is currently being processed by the receiving entity.
\n* registered -The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.
", "enum" : [ "scheduled", "skipped", "in_progress", "success", "failed", "registered", "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ], "example" : null }, "message" : { "type" : "string", "deprecated" : false, "description" : "Detailed information about the status of the e-invoice. When status\nis skipped\nor failed\n, this contains the reason or error details. The following are some valid examples:
When offering subscriptions of products or services, each entity that is made available for sale is represented by an "item" object. Items therefore represent the various plans, addons or charges that you offer as part of your product catalog. Non-metered items are charged upfront in Chargebee, while metered items are charged at the end of the billing cycle, based on usage.
There are three types of items and they're listed and explained here. Examples for each type are provided in the table that follows.
Plan-items are items that have a recurring charge and are an essential component of any subscription. Typically, plans represent a principal or key product or service in your catalog. They are charged at recurring intervals and often have other products or services offered along with them as addons and charges.
Addon-items are items that are sold along with a plan and are charged for at recurring intervals.
Charge-items are items that are sold along with a plan but charged once (or each time) a specified event occurs. A charge can also be applied to a customer without attaching to a subscription.
To help understand each type of item better, listed below are some examples of items from different business domains:
Description of the item. This is visible only in Chargebee and not to customers.
\nNote:
- testing - desc .\nTotal with tags: 38 characters,\ninner text: 'testing desc' (12 characters).The status of the item.
\n* archived -The item is no longer active and no new item prices can be created
\n* active -The item can be used to create new item prices.
\n* deleted -Indicates that the item has been deleted.\nThe id\nand name\ncan be reused. Deleted items can be retrieved using List items\n.
The version number of this resource. For every change made to the resource, resource_version\nis updated with a new timestamp in milliseconds.
The id\nof the Item family\nthat the item belongs to. Is mandatory when Product Families\nhave been enabled.
If enabled_for_checkout\n, then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.
The item is included in MRR calculations for your site. This attribute is only applicable for items of type = charge\nand when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude charge-items from MRR calculations, this value is always returned false\n.
Indicates which addon-items and charge-items can be applied to the item. Only meant for plan-items. Other details of attaching items such as whether to attach as a mandatory item or to attach on a certain event, can be specified using the Create\nor Update an attached item\nAPI.
\n* all -all addon-items and charge-items are applicable to this plan-item.
\n* restricted -only the addon-items or charge-items provided in applicable_items\ncan be applied to this plan-item.
Specifies whether the item undergoes metered billing. When true\n, the quantity is calculated from usage records.\nWhen false\n, the quantity\nis as determined while adding an item price to the subscription. Applicable only for items of type\nplan\nor addon\nand when Metered Billing\nis enabled. The value of this attribute cannot be changed.
How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is metered.\nThis value overrides the one set at the site level\n.
the net quantity is the sum of the quantity\nof all usages for the current term.
from among the usage records for the item price\nwith usage_date\nwithin the relevant billing period, the quantity\nof the usage record with the most recent usage_date\nis taken as the net quantity consumed.
from among the usage records for the item price\nwith usage_date\nwithin the relevant billing period, the quantity\nof the usage record with the maximum value is taken as the net quantity consumed.
The list of addons and charges that are allowed to be applied to the plan. This attribute is applicable only for plan-items and that too when item_applicability\nis restricted\n.
Other details of attaching items can be specified using the Create\nor Update an attached item\nAPI.
", "items" : { "type" : "object", "deprecated" : false, "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Id of the addon-item or plan-item that can be applied to the plan-item.\n", "maxLength" : 100, "example" : null } }, "example" : null }, "example" : null }, "bundle_items" : { "type" : "array", "deprecated" : false, "description" : "The list of items(plans, addons, and charges) added to the bundle plan. This attribute is only available when the item_type\nis plan\n.
This attribute holds additional information about the bundle item. This attribute is only available when the item_type\nis plan\n.
Type of the bundle
\n* fixed -Fixed bundle_configuration.type\nappears when you create a bundle plan that cannot be updated during checkout or subscription creation.
A unique identifier for the item_entitlement.\nThis is auto-generated.
The id\nof the item\nto which this entitlement belongs.
The type\nof the item\nto which this entitlement belongs.
Charge
\n* item -Item
\n* subscription -Subscription
\n* addon -Addon
\n* plan -Plan
", "enum" : [ "plan", "addon", "charge", "subscription", "item" ], "example" : null }, "feature_id" : { "type" : "string", "deprecated" : false, "description" : "The id\nof the feature towards which this entitlement has been granted.
The name\nof the feature\ntowards which this entitlement has been granted.
The level of entitlement that the item has towards the feature. The possible values depend on the value of feature.type\n:
When feature.type is quantity and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any one of feature.levels[value][].
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can also be:
feature.levels[value][]unlimited (case-insensitive), indicating unlimited entitlement.When type is range and:
If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any whole number between levels[value][0] and levels[value][1] (inclusive).
If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can be:
levels[value][0]unlimited (case-insensitive), indicating unlimited entitlement.When type is custom, then the value can be any one of feature.levels[value][].
When type is switch, then the value is set as available or true.
The display name for the entitlement level. The default values are auto-generated based on feature.type as follows:
feature.type is quantity or range, then name is the space-separated concatenation of value and the pluralized version of feature.unit. For example, if value is 20 and feature.unit is user, then name becomes 20 users.feature.type is custom, then name is the same as value.feature.type is switch, the name is set to Available when value is true; it's set to Not Available when value is false.Status of the item family.
\n* active -The item family is active and can be used to create new items.
\n* deleted -The item family has been deleted and cannot be used to create new items. The id\nand name\ncan be reused to create a new item family.
The version number of this resource. For every change made to the resource, resource_version\nis updated with a new timestamp in milliseconds.
The unique ID of the\nbusiness entity\nof this item_family.\nThis is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
An item price is a price point for an item. It defines the currency, pricing model, price, billing period and other attributes for an item. For example, consider a cloud storage service as an item. Then each of the following defines an item price:
The cloud storage sold at USD 10 per month.
\nThe same service sold at AUD 100 per year.
\nThe service sold at a monthly rate determined by the following stairstep pricing model:
\n1-10 users for EUR 10
\n11-25 users for EUR 20
\n26-50 users for EUR 45
\n51 and above for EUR 100
\nThe billing period\nof an item price (only applies to plan-item prices and addon-item prices), is the period\nof the item price in period_unit\ns. An item can have only one item price for a given currency and billing period.
The type of an item price corresponds to the type of the item that the item price belongs to. In other words, item prices can be of the following types:
A unique display name for the item price in the Chargebee UI. If external_name\nis not provided, this is also used in customer-facing pages and documents such as invoices\nand hosted pages\n.
Description of the item price.
\nNote:
- testing - desc .\nTotal with tags: 38 characters,\ninner text: 'testing desc' (12 characters).The status of the item price.
\n* archived -The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.
\n* active -The item price can be used in subscriptions.
\n* deleted -Indicates that the item price has been deleted. The id\nand name\ncan be reused.
The name of the item price used in customer-facing pages and documents. These include invoices\nand hosted pages.\nIf not provided, then name\nis used
Note\nApplicable only for item prices with:
item_type = addon.pricing_model = per_unit.Specifies how to manage charges or credits for the addon item price during a subscription update\nor estimating\na subscription update.
\n* site_default -Use the site-wide proration setting\n.
\n* partial_term -Prorate the charges or credits for the rest of the current term.
\n* full_term -Charge the full price of the addon item price or give the full credit. Don't apply any proration.
", "enum" : [ "site_default", "partial_term", "full_term" ], "example" : null }, "pricing_model" : { "type" : "string", "default" : "flat_fee", "deprecated" : false, "description" : "The pricing scheme for this item price. If subscriptions, invoices or differential prices exist for this item price, pricing_model cannot be changed.
There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
\n* per_unit -A fixed price per unit quantity.
\n* flat_fee -A fixed price that is not quantity-based.
\n* volume -The per unit price is based on the tier that the total quantity falls in.
\n* stairstep -A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
", "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ], "example" : null }, "price" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The cost of the item price when the pricing model is flat_fee.\nWhen the pricing model is per_unit\n, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the minor unit of the currency\n.
The price of the item when the pricing_model is flat_fee.\nWhen the pricing model is per_unit\n, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when multi-decimal pricing\nis enabled.
type is plan: The billing period of the plan in period_units. For example, create a 6 month plan by providing period as 6 and period_unit as month.type is addon: The period of the addon in period_units. For example, create an addon with a 2 month period by providing period as 2 and period_unit as month. The period of an addon is the duration for which its price applies. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.If subscriptions or invoices exist for this item price, period\ncannot be changed. The period\nis mandatory when the item type\nis plan\nor addon
The currency code (ISO 4217 format\n) for the item price. If subscriptions, invoices or differential prices\nexist for this item price, currency_code\ncannot be changed.
The unit of time for period.\nIf subscriptions or invoices exist for this item price, period_unit\ncannot be changed. The period_unit\nis mandatory when the item type\nis plan\nor addon
A period of 1 calendar month.
\n* day -A period of 24 hours.
\n* week -A period of 7 days.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "trial_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The trial period of the plan in trial_period_unit\ns. You can also set trial periods for addons\n; contact Support\nto enable that feature.
The unit of time for trial_period\n.
A period of 1 calendar month.
\n* day -A period of 24 hours.
", "enum" : [ "day", "month" ], "example" : null }, "trial_end_action" : { "type" : "string", "deprecated" : false, "description" : "Applicable only when End-of-trial Action\nhas been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the item.type\nis plan\nand a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the subscription-level\n.
The subscription cancels.
\n* activate_subscription -The subscription activates and charges are raised for non-metered items.
\n* site_default -The action configured for the site\nat the time when the trial ends, takes effect.
", "enum" : [ "site_default", "activate_subscription", "cancel_subscription" ], "example" : null }, "shipping_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Defines the shipping frequency. Example: to bill customer every 2 weeks, provide \"2\" here.\n", "minimum" : 1, "example" : null }, "shipping_period_unit" : { "type" : "string", "deprecated" : false, "description" : "Defines the shipping frequency in association with shipping period.\n\\* year -\n\nA period of 1 calendar year.\n\\* day -\n\nA period of 24 hours.\n\\* week -\n\nA period of 7 days.\n\\* month -\n\nA period of 1 calendar month.\n", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "billing_cycles" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The default number of billing cycles a subscription to the plan must run. Can be overridden for a subscription.\nAddons can also have billing cycles. Also, for addons, you can override this while attaching it to a plan. However, if you provide the value while applying the addon to a subscription, then that value takes still higher precedence.\nIf subscriptions, invoices or differential prices\nexist for this item price, billing_cycles\ncannot be changed.
Note:\nIf you want to change the billing_cycles\nto unlimited renewals, enter an empty string. This value can only be updated if the item_price\nis not attached to a subscription or invoice. If no billing_cycles\nvalue is entered, then by default the value will be set as unlimited billing_cycles\nrenewals.
Free quantity the subscriptions of this plan item_price will have. Only the quantity exceeding this value will be charged in the subscription.
Note:
free_quantity is currently supported only for plan item_price.free_quantity\nis not supported for the Usage-Based Billing\n(UBB). All included or free quantities should be configured exclusively through entitlements\n.Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
Specifies the frequency at which the usage counter needs to be reset.
\nNote:\nChanges to the usage_accumulation_reset_frequency\nparameter for item_price\nis not allowed if the item\nis already linked to a subscription.
Accumulates usage without ever resetting it.
\n* subscription_billing_frequency -Accumulates usage until the subscription's billing frequency ends.
", "enum" : [ "never", "subscription_billing_frequency" ], "example" : null }, "archived_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp indicating when this item price was archived.\n", "example" : null }, "invoice_notes" : { "type" : "string", "deprecated" : false, "description" : "A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)\ndisplayed on the invoice PDF.\n", "maxLength" : 2000, "example" : null }, "is_taxable" : { "type" : "boolean", "default" : true, "deprecated" : false, "description" : "Specifies whether taxes apply to this item price. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)\nhave been disabled in Chargebee. However, the value is effective only while Taxes are enabled.\n", "example" : null }, "metadata" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "A collection of key-value pairs that provides extra information about the item price. \\[Learn more\\](/docs/api/advanced-features#metadata) .\n", "example" : null }, "item_type" : { "type" : "string", "deprecated" : false, "description" : "Type of item.\n\\* charge -\n\nA non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer [directly](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge)\nwithout being applied to a subscription.\n\\* plan -\n\nAn essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription.\n\\* addon -\n\nA recurring component that can be added to a subscription in addition to its plan.\n", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "show_description_in_invoices" : { "type" : "boolean", "deprecated" : false, "description" : "Whether the item price's description should be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf).\nIf this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/invoice-operations.html#actions-for-payment-due-not-paid-invoices_regenerate-invoice)\n) after the change are affected; past invoices are not.\n", "example" : null }, "show_description_in_quotes" : { "type" : "boolean", "deprecated" : false, "description" : "Whether the item price's description should be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).\nIf this Boolean is changed, only quotes created after the change are affected; past quotes are not.\n", "example" : null }, "deleted" : { "type" : "boolean", "deprecated" : false, "description" : "Indicates whether the item price has been deleted ot not.\n", "example" : null }, "business_entity_id" : { "type" : "string", "deprecated" : false, "description" : "The unique ID of the\nbusiness entity\nof this item_family.\nThis is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
List of quantity-based pricing tiers for the item price. Applicable only for tiered\n, volume\n, and stairstep\npricing_models\n.
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.
Pricing type for the tier.
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20, consuming 400 units will result in a charge of $80 (4 × $20).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Used exclusively with the following accounting integrations
\n: . For example:Location: Singapore.::...: : .... For example: Services: Plan.Used exclusively with the following accounting integrations
\n: .... For example, Region: South::.... For example: Location: North America: Canada: : .... For example: NA:US:CAUsed exclusively with the following accounting integrations
\n: : .... For example: Production: Assembly.A case-sensitive display name for the entitlement level. Provide a name that helps you clearly identify the entitlement level. For example: a feature such as Email Support\ncan have entitlement levels named as All weekdays\n, All days\n, 40 hours per week\nand so on.
When not provided for feature.type\nquantity\nor range\n, this name is auto-generated as the space-separated concatenation of levels[].value\nand the pluralized version of unit.\nFor example, if levels[].value\nis 20\nand unit\nis user\n, then levels[].name\nbecomes 20 users\n.
The value denoting the entitlement level granted.
\ntype is quantity: this attribute denotes the quantity of units of the feature for this entitlement level. For example, a feature such as number of users can have levels[].value as 5, 20, 50, and 100. levels[].is_unlimited is used to set the entitlement level to "unlimited".type is range: there can be be only two elements in the levels[] array; one corresponding to the minimum value (levels[0]) and the other to the maximum value (levels[1]) of the range of possible entitlement levels. For example, a feature such as number of users may have levels[0].value = 5 and levels[1].value = 50000. When the upper limit is "unlimited", then levels[1].value is not set and levels[1].is_unlimited is true.type is custom: this attribute denotes the value of this custom entitlement level. For example, a feature Email Support can have levels[].value as one of say, 24×7 and 24×5.This attribute represents the order of the entitlement levels from lowest to highest.
\ntype is quantity or custom: The lowest entitlement level has the value 0, the next higher level has the value 1, followed by 2, and so on.type is range: This attribute is 0 for the minimum value and 1 for the maximum value in the range.When not defined, it is assumed as the index of the levels[]\narray.
When type\nis quantity\nor range\n, this attribute indicates whether the entitlement level corresponds to unlimited units of the feature. Possible values:
true: The entitlement level corresponds to unlimited units of the feature. levels[].value is ignored for this level. This can only be set for the level that has the highest value for levels[].level.false: The entitlement level does not correspond to unlimited units of the feature.The alternative text\nfor the image. Applicable only when the top-level media_type\nis image\n.
The subscription_item.item_price_id where the item_type is charge.
Offer fulfillment allows you to initiate, update, and retrieve the lifecycle of an offer fulfillment, after a personalized offer has been accepted. Whether the personalized offer triggers a direct billing change, a hosted checkout flow, or a redirect-based workflow, these APIs track acceptance, execution status, and completion, providing a consistent interface for fulfillment tracking and notifications.
Features of this object:
in_progress, completed, failed).Current status of the offer fulfillment process.
\n* in_progress -The offer fulfillment is underway (not yet completed).
\n* completed -The offer was successfully applied . For URL redirects, this might be returned immediately if the action is completed, potentially along with a redirect_url if the user should be navigated to a specific page.
\n* failed -The offer fulfillment failed. The error object\nfield will be present to provide more details in this case.
App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
The id\nof the customer\nobject that is associated with this one time order.
The identifier of the one_time_purchase in the source.\nFor Apple App Store, it is the Transaction ID\nof the initial_purchase_transaction.\nFor Google Play Store, it is the Order ID\nof the initial_purchase_transaction\n.
Country code indicating where the one-time order originated, such as US\nfor the United States.
The source\nwhere the one-time order was originally made and managed.
The source of the app is google_play_store\n.
The source of the app is apple_app_store\n.
Indicates timestamp when the omnichannel_one_time_order\ncreated in Chargebee.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
Uniquely identifies a omnichannel_one_time_order_item
Identifier of the purchased item in the original source\n(e.g., apple_app_store\nor google_play_store\n).
Product type in the source\n.
Indicates timestamp when this specific omnichannel_one_time_order_item\nwas cancelled\nin the source\n.
The reason of the omnichannel_one_time_order\ncancellation for an item.
Indicates timestamp when the omnichannel_one_time_order_item\ncreated in Chargebee.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
Unique identifier for the omnichannel_transaction\n.
The identifier of the one time order in the source.\nFor Apple App Store, it is the Transaction ID\nof the initial_purchase_transaction.\nFor Google Play Store, it is the Order ID\nof the initial_purchase_transaction\n.
App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
The whole units of the amount.\nFor example:\nif currencyCode is USD (i.e. two decimal currency), then the unit value for USD 1.23 will be 1\nif currencyCode is JPY (i.e. zero decimal currency), then the unit value for JPY 123 will be 123\nif currencyCode is BHD (i.e. three decimal currency), then the unit value for BHD 1.234 will be 1
The fractional price amount, in nanos (billionths of the currency unit).\nThe value must be between 0 and +999,999,999 inclusive.\nFor example:\nIf currencyCode is USD (i.e. two decimal currency), then nanos value for USD 1.23 will be 230,000,000\nIf currencyCode is JPY (i.e. zero decimal currency), then nanos value for JPY 123 will be 0\nIf currencyCode is BHD (i.e. three decimal currency), then nanos value for BHD 1.234 will be 234,000,000
The type of transaction that occurred in the source\n.
Indicates that the transaction was initiated as part of a renewal for a previously completed purchase.
\n* purchase -Indicates that the transaction occurred for a purchase.
", "enum" : [ "purchase", "renewal" ], "example" : null }, "transacted_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp when the transaction occurred in the source\n.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
A list of omnichannel_subscription\nobjects linked to this transaction. Each entry represents a subscription associated with the transaction.
A list of omnichannel_one_time_order\nobjects linked to this transaction. Each entry represents a one-time order associated with the transaction.
The identifier of the subscription in the source.\nFor Apple App Store, it is the Transaction ID\nof the initial_purchase_transaction\n.
App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
The source\nwhere the purchase is originally made and managed.
When source of the application is Google Play Store
\n* apple_app_store -When source of the application is Apple App Store
", "enum" : [ "apple_app_store", "google_play_store" ], "example" : null }, "customer_id" : { "type" : "string", "deprecated" : false, "description" : "The id\nof the customer\nobject that is associated with this purchase.
Indicates timestamp when the omnichannel_subscription\ncreated in Chargebee.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource.
Uniquely identifies a omnichannel_subscription_item\n.
Product ID in the source\n.
The parent name of the product ID in the source\n.
Status of the omnichannel_subscription_item.\nLearn more\nabout status and their mapping with the store's status.
When the subscription associated with the omnichannel_subscription_item\nis active
When the subscription associated with the omnichannel_subscription_item\nis in_dunning\n.
When the subscription associated with the omnichannel_subscription_item\nis expired
When the subscription associated with the omnichannel_subscription_item\nis cancelled
When the subscription associated with the omnichannel_subscription_item\nis in_grace_period\n.
When the subscription associated with the omnichannel_subscription_item\nis paused\n.
The renewal status for the omnichannel_subscription_item\n.
The auto-renewal of omnichannel_subscription_item\nis disabled.
The auto-renewal of omnichannel_subscription_item\nis enabled.
Start of the current billing period of the subscription item. It is applicable only if the status\nis active\n.
End of the current billing period of the subscription item. It is applicable only if the status\nis active.
\n", "example" : null }, "expired_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Note:\nThis timestamp can be considered closest to the next_billing_at\ntimestamp as Apple does not provide information on the next renewal. Apple can renew the subscription 24 hours before it expires, and after entering the billing retry state, it can attempt to renew the subscription for up to 60 days. Learn more\n.
\n
Indicates timestamp when the subscription associated with the omnichannel_subscription_item\nwas expired\nin the source
Indicates timestamp when the subscription associated with the omnichannel_subscription_item\nwas cancelled\nin the source
Indicates timestamp when the grace period of subscription associated with the omnichannel_subscription_item\nexpires in the source
Indicates timestamp when the subscription automatically resumes after being set to paused\n.
Indicates whether the omnichannel_subscription_item\nhas any scheduled changes.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource.
Represents the omnichannel_subscription_item_offers\nassociated with the omnichannel_subscription_item\n.
Unique identifier for the omnichannel_subscription_item_offer.\nSystem-generated.
Indicates functional purpose of the offer. For example, introductory\nindicates a first-time offer for new subscribers.
Introductory offer for first-time subscribers, typically providing special pricing or terms for the first billing cycle.
\n* promotional -Promotional offer that may be available to both new and existing subscribers, often featuring limited-time pricing or terms.
\n* developer_determined -Offer terms are determined by the developer and may include unique pricing or features.\nNote: Support for this category is planned for a future update.
", "enum" : [ "introductory", "promotional", "developer_determined" ], "example" : null }, "category_at_source" : { "type" : "string", "deprecated" : false, "description" : "Category label as defined by the source platform (for example, Apple App Store or Google Play Store). Directly fetched from the source; useful for debugging or platform-specific workflows.\n", "maxLength" : 100, "example" : null }, "type" : { "type" : "string", "deprecated" : false, "description" : "Indicates how the offer is applied from a pricing-model perspective.\n\\* free_trial -\n\nProvides a free trial period. The customer is not charged during the trial; regular billing begins after the trial ends.\n\\* pay_up_front -\n\nRequires a fixed upfront payment for a defined subscription period, often at a discount. For example, pay for two months in advance.\n\\* pay_as_you_go -\n\nApplies a recurring discounted price at each billing cycle over multiple renewals, such as on a monthly plan, a discount on the initial purchase, and the next three billing cycles.\n", "enum" : [ "free_trial", "pay_up_front", "pay_as_you_go" ], "example" : null }, "type_at_source" : { "type" : "string", "deprecated" : false, "description" : "Offer type as recorded by the source platform (for example, Apple App Store or Google Play Store), such as category_at_source is useful for tracking and audit.
Indicates how long the offer applies to the subscription. This attribute uses ISO 8601 duration format. For example, P1M\n(1 month), P7D\n(7 days). After this duration, regular pricing resumes.
Used when discount_type\nis percentage.\nSpecifies the discount as a decimal value. For example, a value of 12.5 corresponds to a 12.5% discount.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource.
This field contains information about the upcoming renewal. It is present only if the source\nprovides renewal information (currently available only for Google Play Store purchases) and the omnichannel_subscription_item\n's auto_renew_status\nis set to on\nto renew for the next term. Otherwise, this field is absent.
The whole units of the amount.\nFor example:\nif currencyCode is USD (i.e. two decimal currency), then the unit value for USD 1.23 will be 1\nif currencyCode is JPY (i.e. zero decimal currency), then the unit value for JPY 123 will be 123\nif currencyCode is BHD (i.e. three decimal currency), then the unit value for BHD 1.234 will be 1
The fractional price amount, in nanos (billionths of the currency unit), for the next renewal.\nThe value must be between 0 and +999,999,999 inclusive.\nFor example:\nIf currencyCode is USD (i.e. two decimal currency), then nanos value for USD 1.23 will be 230,000,000\nIf currencyCode is JPY (i.e. zero decimal currency), then nanos value for JPY 123 will be 0\nIf currencyCode is BHD (i.e. three decimal currency), then nanos value for BHD 1.234 will be 234,000,000
Represents an active product catalog mapping between an omnichannel_subscription_item\nand a Chargebee item.\nUse this attribute to retrieve entitlements for the omnichannel_subscription_item\nthat are associated with the linked Chargebee item\n.
Represents the item_id\nof the Chargebee item linked to the omnichannel_subscription_item\n.
Indicates the timestamp when the mapping between the omnichannel_subscription_item\nand the Chargebee item\nwas created in Chargebee.
The identifier of the subscription in the source.\nFor Apple App Store, it is the Transaction ID\nof the initial_purchase_transaction.\nFor Google Play Store, it is the Order ID\nof the initial_purchase_transaction\n.
App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
The whole units of the amount.\nFor example:\nif currencyCode is USD (i.e. two decimal currency), then the unit value for USD 1.23 will be 1\nif currencyCode is JPY (i.e. zero decimal currency), then the unit value for JPY 123 will be 123\nif currencyCode is BHD (i.e. three decimal currency), then the unit value for BHD 1.234 will be 1
The fractional price amount, in nanos (billionths of the currency unit), for the next renewal.\nThe value must be between 0 and +999,999,999 inclusive.\nFor example:\nIf currencyCode is USD (i.e. two decimal currency), then nanos value for USD 1.23 will be 230,000,000\nIf currencyCode is JPY (i.e. zero decimal currency), then nanos value for JPY 123 will be 0\nIf currencyCode is BHD (i.e. three decimal currency), then nanos value for BHD 1.234 will be 234,000,000
Timestamp denoting the time when the transaction occurred in source
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
A list of omnichannel_subscription\nobjects linked to this transaction. Each entry represents a subscription associated with the initial purchase transaction.
A list of omnichannel_one_time_order\nobjects linked to this transaction. Each entry represents a one-time order associated with the initial purchase transaction.
Uniquely identifies a omnichannel_subscription_item\n.
Product ID in the source\n.
The parent name of the product ID in the source\n.
Status of the omnichannel_subscription_item.\nLearn more\nabout status and their mapping with the store's status.
When the subscription associated with the omnichannel_subscription_item\nis in_grace_period
When the subscription associated with the omnichannel_subscription_item\nis in_dunning
When the subscription associated with the omnichannel_subscription_item\nis expired
When the subscription associated with the omnichannel_subscription_item\nis active
When the subscription associated with the omnichannel_subscription_item\nis cancelled
When the subscription associated with the omnichannel_subscription_item\nis paused
The renewal status for the omnichannel_subscription_item\n.
The auto-renewal of omnichannel_subscription_item\nis enabled.
The auto-renewal of omnichannel_subscription_item\nis disabled.
Start of the current billing period of the subscription item. It is applicable only if the status\nis active\n.
End of the current billing period of the subscription item. It is applicable only if the status\nis active\n.
Indicates timestamp when the subscription associated with the omnichannel_subscription_item\nwas expired\nin the source
Indicates timestamp when the subscription associated with the omnichannel_subscription_item\nwas cancelled\nin the source
Indicates timestamp when the grace period of subscription associated with the omnichannel_subscription_item\nexpires in the source
Indicates timestamp when the subscription automatically resumes after being set to paused\n.
Indicates whether the omnichannel_subscription_item\nhas any scheduled changes.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource.
Represents the omnichannel_subscription_item_offers\nassociated with the omnichannel_subscription_item\n.
Unique identifier for the omnichannel_subscription_item_offer.\nSystem-generated.
Indicates functional purpose of the offer. For example, introductory\nindicates a first-time offer for new subscribers.
Offer terms are determined by the developer and may include unique pricing or features.\nNote: Support for this category is planned for a future update.
\n* promotional -Promotional offer that may be available to both new and existing subscribers, often featuring limited-time pricing or terms.
\n* introductory -Introductory offer for first-time subscribers, typically providing special pricing or terms for the first billing cycle.
", "enum" : [ "introductory", "promotional", "developer_determined" ], "example" : null }, "category_at_source" : { "type" : "string", "deprecated" : false, "description" : "Category label as defined by the source platform (for example, Apple App Store or Google Play Store). Directly fetched from the source; useful for debugging or platform-specific workflows.\n", "maxLength" : 100, "example" : null }, "type" : { "type" : "string", "deprecated" : false, "description" : "Indicates how the offer is applied from a pricing-model perspective.\n\\* pay_as_you_go -\n\nApplies a recurring discounted price at each billing cycle over multiple renewals, such as on a monthly plan, a discount on the initial purchase, and the next three billing cycles.\n\\* free_trial -\n\nProvides a free trial period. The customer is not charged during the trial; regular billing begins after the trial ends.\n\\* pay_up_front -\n\nRequires a fixed upfront payment for a defined subscription period, often at a discount. For example, pay for two months in advance.\n", "enum" : [ "free_trial", "pay_up_front", "pay_as_you_go" ], "example" : null }, "type_at_source" : { "type" : "string", "deprecated" : false, "description" : "Offer type as recorded by the source platform (for example, Apple App Store or Google Play Store), such as category_at_source is useful for tracking and audit.
Indicates how long the offer applies to the subscription. This attribute uses ISO 8601 duration format. For example, P1M\n(1 month), P7D\n(7 days). After this duration, regular pricing resumes.
Used when discount_type\nis percentage.\nSpecifies the discount as a decimal value. For example, a value of 12.5 corresponds to a 12.5% discount.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource.
This field contains information about the upcoming renewal. It is present only if the source\nprovides renewal information (currently available only for Google Play Store purchases) and the omnichannel_subscription_item\n's auto_renew_status\nis set to on\nto renew for the next term. Otherwise, this field is absent.
The whole units of the amount.\nFor example:\nif currencyCode is USD (i.e. two decimal currency), then the unit value for USD 1.23 will be 1\nif currencyCode is JPY (i.e. zero decimal currency), then the unit value for JPY 123 will be 123\nif currencyCode is BHD (i.e. three decimal currency), then the unit value for BHD 1.234 will be 1
The fractional price amount, in nanos (billionths of the currency unit), for the next renewal.\nThe value must be between 0 and +999,999,999 inclusive.\nFor example:\nIf currencyCode is USD (i.e. two decimal currency), then nanos value for USD 1.23 will be 230,000,000\nIf currencyCode is JPY (i.e. zero decimal currency), then nanos value for JPY 123 will be 0\nIf currencyCode is BHD (i.e. three decimal currency), then nanos value for BHD 1.234 will be 234,000,000
Represents an active product catalog mapping between an omnichannel_subscription_item\nand a Chargebee item.\nUse this attribute to retrieve entitlements for the omnichannel_subscription_item\nthat are associated with the linked Chargebee item\n.
Represents the item_id\nof the Chargebee item linked to the omnichannel_subscription_item\n.
Indicates the timestamp when the mapping between the omnichannel_subscription_item\nand the Chargebee item\nwas created in Chargebee.
Uniquely identifies an omnichannel_subscription_item_scheduled_change\n.
The id\nof the Omnichannel subscription item\nobject associated with this scheduled change.
When a change to the omnichannel_subscription_item\nis scheduled, this is the date and time when it takes effect.
Indicates the type of scheduled change.
\n* downgrade -The scheduled change type is downgrade
Indicates timestamp when the omnichannel_subscription_item_scheduled_change\nwas created in Chargebee.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource.
Applicable only if change_type\nis downgrade\n.
Applicable only if change_type\nis downgrade\n.
App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
The whole units of the amount.\nFor example:\nif currencyCode is USD (i.e. two decimal currency), then the unit value for USD 1.23 will be 1\nif currencyCode is JPY (i.e. zero decimal currency), then the unit value for JPY 123 will be 123\nif currencyCode is BHD (i.e. three decimal currency), then the unit value for BHD 1.234 will be 1
The fraction part of the amount.\nThe value must be between 0 and +999,999,999 inclusive.\nFor example:\nIf currencyCode is USD (i.e. two decimal currency), then nanos value for USD 1.23 will be 230,000,000\nIf currencyCode is JPY (i.e. zero decimal currency), then nanos value for JPY 123 will be 0\nIf currencyCode is BHD (i.e. three decimal currency), then nanos value for BHD 1.234 will be 234,000,000
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Type of this discount line item
\n* prorated_credits -Represents the credit adjustment items in invoice. The 'coupon_id' attribute will be null in this case
\n* document_level_coupon -Represents the 'Document' level coupons applied to this document. Further the 'coupon_id' attribute specifies the coupon\nid this discount is based on
\n* custom_discount -Represents the discount applied on an resent order against the orginal order.
\n* promotional_credits -Represents the Promotional Credits item in invoice. The 'coupon_id' attribute will be null in this case
\n* item_level_coupon -Represents the 'Item' level coupons applied to this invoice. Further the 'coupon_id' attribute specifies the coupon\nid this discount is based on
\n* document_level_discount -The deduction is due to a discount applied to the invoice sub_total.\nThe discount id is available as the entity_id.
The deduction is due to a discount applied to a line item of the invoice. The discount id is available as the entity_id.
When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
A payment_intent is created to help you navigate the 3DS flow of collecting payment from your customer. It is necessary only for implementing 3DS flow using Chargebee.js.
All payment_intents with status as inited, in_progress or authorized become expired after an hour automatically.
The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.
The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type\nis ideal\n, sofort\n, dotpay\nor giropay\n.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
The unique identifier of the customer for whom the payment_intent will be created. If specified, the payment_intent will be used exclusively for that customer. If not specified, the payment_intent won't be associated with any customer and will be available for any customer.
The unique ID of the business entity\nof this payment_intent
Error code received from the payment gateway when the payment_attempt\nfails.
List of payment attempts associated with this PaymentIntent. Each item in the list is a payment_attempt\nobject, identical in structure to active_payment_attempt\n.
Current status of the payment attempt.
\n* requires_challenge -The transaction requires the 3DS Challenge flow, where the customer completes authentication through an inline 3DS 2.0 challenge presented by their card issuer.
\n* requires_identification -Customer's device fingerprint is used to verify their identity. It needs to be sent to the Issuing Bank for verification.
\n* requires_redirection -The transaction must go through the 3DS Redirection flow, where the customer is redirected to their card issuer's authentication page (3DS 1.0) to verify the payment. After authentication, the customer is redirected to the specified success_url\nor failure_url\n.
Payment attempt is initialized.
\n* authorized -3DS verification successfully completed.
\n* pending_authorization -Waiting for the authorization.
\n* refused -3DS verification attempt failed.
", "enum" : [ "inited", "requires_identification", "requires_challenge", "requires_redirection", "authorized", "refused", "pending_authorization" ], "example" : null }, "payment_method_type" : { "type" : "string", "default" : "card", "deprecated" : false, "description" : "The payment method of this attempt.\n\\* swish -\n\nPayments made via Swish\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* alipay -\n\nPayments made via Alipay.\n\\* sofort -\n\nsofort\n\\* giropay -\n\ngiropay\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* 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\\* 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\\* 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\\* ideal -\n\nideal\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* pay_co -\n\nPayments made via PayCo\n\\* venmo -\n\nVenmo\n\\* 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" ], "example" : null }, "id_at_gateway" : { "type" : "string", "deprecated" : false, "description" : "Reference of the payment attempt at the gateway.\n", "maxLength" : 50, "example" : null }, "error_code" : { "type" : "string", "deprecated" : false, "description" : "Error code received from the payment gateway on failure.\n", "maxLength" : 100, "example" : null }, "error_text" : { "type" : "string", "deprecated" : false, "description" : "Error message received from the payment gateway on failure.\n", "maxLength" : 65000, "example" : null }, "checkout_details" : { "type" : "string", "deprecated" : false, "description" : "JSON-encoded object that includes customer and browser details collected during checkout.\n", "maxLength" : 65000, "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp indicating when the payment attempt was created.\n", "example" : null }, "modified_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp indicating when the payment attempt was last modified.\n", "example" : null }, "error_detail" : { "type" : "object", "deprecated" : false, "description" : "Comprehensive information regarding the error experienced during an unsuccessful or declined transaction. Learn more about \\[gateway error references\\](/docs/api/v2/pcv-1/gateway_error_references)\n", "properties" : { "request_id" : { "type" : "string", "deprecated" : false, "description" : "This is a unique identifier assigned by the payment gateway. It is used to track the request at the payment gateway\n", "maxLength" : 100, "example" : null }, "error_category" : { "type" : "string", "deprecated" : false, "description" : "This parameter categorizes the type of error that occurred for the request. It helps in understanding whether the error is due to API error, validation, processing, network issues, and more\n", "maxLength" : 100, "example" : null }, "error_code" : { "type" : "string", "deprecated" : false, "description" : "A gateway-specific code that corresponds to the particular error encountered for the request. This code can be used for identifying the error in a standardized manner across the gateway's services\n", "maxLength" : 100, "example" : null }, "error_message" : { "type" : "string", "deprecated" : false, "description" : "A message provided by the gateway that describes the nature of the error encountered\n", "maxLength" : 65000, "example" : null }, "decline_code" : { "type" : "string", "deprecated" : false, "description" : "Code provided by the gateway that specifies the reason for the transaction decline.\n", "maxLength" : 100, "example" : null }, "decline_message" : { "type" : "string", "deprecated" : false, "description" : "Descriptive message explaining the reason for the transaction's decline.\n", "maxLength" : 65000, "example" : null }, "network_error_code" : { "type" : "string", "deprecated" : false, "description" : "This code represents errors that originate from the payment network (such as Visa, MasterCard, and more). It is different from the gateway error code and is specific to the network's error-handling system\n", "maxLength" : 100, "example" : null }, "network_error_message" : { "type" : "string", "deprecated" : false, "description" : "This is the network-related error message from the gateway; a detailed message provided by the payment network explaining the nature of the network error encountered\n", "maxLength" : 65000, "example" : null }, "error_field" : { "type" : "string", "deprecated" : false, "description" : "This parameter indicates which specific data field or attribute in the request caused the error\n", "maxLength" : 100, "example" : null }, "recommendation_code" : { "type" : "string", "deprecated" : false, "description" : "After an error has occurred, the gateway or payment network may provide a recommendation code. This code suggests a course of action or remedy that you can follow to resolve the issue\n", "maxLength" : 100, "example" : null }, "recommendation_message" : { "type" : "string", "deprecated" : false, "description" : "This message is intended to provide guidance or suggestions on action or remedy that you can follow to resolve the issue\n", "maxLength" : 65000, "example" : null }, "processor_error_code" : { "type" : "string", "deprecated" : false, "description" : "This code is provided by the payment processor (the entity that handles the transaction between the bank accounts and the payment networks) and indicates errors that occur at this stage of the payment process\n", "maxLength" : 100, "example" : null }, "processor_error_message" : { "type" : "string", "deprecated" : false, "description" : "This message describes the specific error that the payment processor encountered\n", "maxLength" : 65000, "example" : null }, "error_cause_id" : { "type" : "string", "deprecated" : false, "description" : "A [Chargebee-defined code](/docs/api/errors)\nthat corresponds to the specific error encountered during the request. This code helps in identifying and standardizing the error across different gateway services for consistent error handling.\n", "maxLength" : 150, "example" : null }, "processor_advice_code" : { "type" : "string", "deprecated" : false, "description" : "Advice code returned by the payment gateway or processor that provides guidance on how to handle a declined transaction, for example, whether to retry or take a different action.\n", "maxLength" : 100, "example" : null } }, "example" : null } }, "required" : [ "created_at", "modified_at", "status" ], "example" : null }, "example" : null } }, "required" : [ "amount", "created_at", "customer_id", "expires_at", "id", "modified_at", "status" ], "example" : null }, "PaymentIntentCreatedEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the event\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "example" : null }, "content" : { "type" : "object", "properties" : { "payment_intent" : { "$ref" : "#/components/schemas/PaymentIntent" } }, "required" : [ "payment_intent" ], "example" : null } }, "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ], "example" : null }, "PaymentIntentUpdatedEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the event\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "example" : null }, "content" : { "type" : "object", "properties" : { "payment_intent" : { "$ref" : "#/components/schemas/PaymentIntent" } }, "required" : [ "payment_intent" ], "example" : null } }, "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ], "example" : null }, "PaymentMethod" : { "type" : "string", "default" : "card", "deprecated" : false, "enum" : [ "cash", "check", "bank_transfer", "other", "custom", "chargeback", "card", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna" ], "example" : null }, "PaymentMethodSavePolicy" : { "type" : "string", "deprecated" : false, "enum" : [ "always", "ask", "never" ], "example" : null }, "PaymentMethodType" : { "type" : "string", "deprecated" : false, "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "apple_pay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna" ], "example" : null }, "PaymentReferenceNumber" : { "type" : "object", "description" : "Using this resource you can create reference numbers for Payment Instructions at the invoice level, allowing for multiple payment information and payment reference numbers to be associated with a single invoice. However, only one PRN is generated for each payment method.\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "The id\nof the payment_reference_number\nresource is a unique identifier assigned to the PRN to track and reference in systems.
This attribute helps type\nfield in the API, specifies how to reconcile offline payments, and generate payment_reference_number\non invoices based on country-specific rules. Setting the type\nfield generates payment_reference_number\nfor the respective country and includes them on the invoice for correct reconciliation.
The reference number printed on invoices in Finland is utilized by buyers for payment via bank transfer, facilitating the association of payments with invoices.
\n* fik -Denmark based number calculated using recursive MOD 10 algorithm.
\n* kid -The KID number (kundeidentifikasjon) in Norway is an abbreviation for "Customer identification". It is used to associate payments with the customer and invoice.
\n* ocr -A OCR-based payment, contains an OCR reference, which is used to identify the vendor and the purchase document in connection with a payment. Swedish reference number can contain customer ID and/or invoice number to identify customer and invoice.
", "enum" : [ "kid", "ocr", "frn", "fik", "swiss_reference" ], "example" : null }, "number" : { "type" : "string", "deprecated" : false, "description" : "A number is generated based on the configuration type of the PRN during the invoice creation process.\n", "maxLength" : 100, "example" : null }, "invoice_id" : { "type" : "string", "deprecated" : false, "description" : "The invoice_id\nof the payment reference number (PRN) resource is the unique identifier assigned to the invoice that the PRN is associated with.
Payment schedules for an invoice refer to a payment structure where the amount_due\non an invoice is divided into smaller, more manageable parts, each of which is paid over a specified period.
The identifier of the payment_schedule_scheme\n, used to create the payment schedules.
The part of the invoice.amount_due\nto be distributed across the payment schedules. If not specified, the entire invoice.amount_due\nis considered by default.
The timestamp at which the payment_schedule\nwas created.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
Defines the status for each payment schedule.
\n* posted -The installment is unpaid or partially paid and the due date (date) has not passed.
The installment is unpaid or partially paid and the due date (date) has passed.
The installment has been paid.
", "enum" : [ "posted", "payment_due", "paid" ], "example" : null } }, "required" : [ "amount", "date", "id", "status" ], "example" : null }, "example" : null } }, "required" : [ "created_at", "entity_id", "entity_type", "id", "scheme_id" ], "example" : null }, "PaymentScheduleEstimate" : { "type" : "object", "properties" : { "id" : { "type" : "string", "deprecated" : false, "maxLength" : 40, "example" : null }, "scheme_id" : { "type" : "string", "deprecated" : false, "maxLength" : 40, "example" : null }, "entity_type" : { "type" : "string", "deprecated" : false, "enum" : [ "invoice" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "maxLength" : 3, "example" : null }, "schedule_entries" : { "type" : "array", "deprecated" : false, "items" : { "type" : "object", "deprecated" : false, "properties" : { "id" : { "type" : "string", "deprecated" : false, "maxLength" : 40, "example" : null }, "date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "minimum" : 0, "example" : null }, "status" : { "type" : "string", "deprecated" : false, "enum" : [ "posted", "payment_due", "paid" ], "example" : null } }, "required" : [ "amount", "date", "id", "status" ], "example" : null }, "example" : null } }, "required" : [ "amount", "entity_type", "id", "scheme_id" ], "example" : null }, "PaymentScheduleScheme" : { "type" : "object", "description" : "Payment schedules for an invoice refer to a payment structure where the amount_due\non an invoice is divided into smaller, more manageable parts, each of which is paid over a specified period. Payment schedule scheme is a configuration or set of rules for creating payment schedules. After creating a payment schedule scheme, you can use it to generate payment schedules for multiple invoices.
Specifies the total number of payment schedules for the invoice. The maximum number_of_schedules\nvaries based on the period_unit\n: - Day: Up to 30 schedules
The time period between the effective dates of two consecutive payment schedules, expressed in period_units. Use this parameter to have fixed intervals between payment schedules. The maximum period\nvaries based on the period_unit\n: - Day: Up to 30 days
The timestamp at which the payment_schedule_scheme\nwas created.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
The unique ID of the business entity\nof this payment_source.\nThis is always the same as the business entity of the customer.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The gateway through which this payment voucher was created.\nNote:\nNote: Currently, stripe\nis the only supported gateway through which you can create the payment voucher.
Twikey is a payment service provider that specializes in processing direct debit payments across the EU.
\n* ecentric -Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities.
\n* bluesnap -BlueSnap is a payment gateway.
\n* jp_morgan -J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different payment_source_type.
\nThis feature is a Private Beta Release. Request access to enable the J.P. Morgan Mobility Payment Solutions gateway via payFURL for your test and live sites.
2Checkout is a payment gateway.
\n* first_data_global -First Data Global Gateway Virtual Terminal Account
\n* exact -Exact Payments is a payment gateway.
\n* deutsche_bank -Deutsche Bank is the leading German bank with strong European roots and a global network.
\nThis feature is a Private Beta Release.
BluePay is a payment gateway.
\n* paypal_express_checkout -PayPal Express Checkout is a payment gateway.
\n* nuvei -Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses.
\nThis feature is a Private Beta Release. Request access to enable Nuvei for your test and live sites.
eWAY Account is a payment gateway.
\n* metrics_global -Metrics global is a leading payment service provider providing unified payment services in the US.
\n* paypal_payflow_pro -PayPal Payflow Pro is a payment gateway.
\n* razorpay -Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc.
\n* global_payments -Global Payments is a payment service provider.
\n* amazon_payments -Amazon Payments is a payment service provider.
\n* dlocal -Dlocal provides payment solutions for global commerce by accepting local payment methods.
\n* not_applicable -Indicates that payment gateway is not applicable for this resource.
\n* windcave -Windcave provides an end to end payment processing solution in ANZ and other leading global markets.
\n* checkout_com -Checkout.com is a payment gateway.
\n* adyen -Adyen is a payment gateway.
\n* braintree -Braintree is a payment gateway.
\n* nmi -NMI is a payment gateway.
\n* quickbooks -Intuit QuickBooks Payments gateway
\n* wepay -WePay is a payment gateway.
\n* worldpay -WorldPay is a payment gateway
\n* paystack -Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline.
\nThis feature is a Private Beta Release. Request access to enable Paystack for your test and live sites.
Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.
\nThis feature is a Private Beta Release.
Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes.
\n* wirecard -WireCard Account is a payment service provider.
\n* chargebee_payments -Chargebee Payments gateway
\n* sage_pay -Sage Pay is a payment gateway.
\n* moneris_us -Moneris USA is a payment gateway.
\n* pin -Pin is a payment gateway
\n* authorize_net -Authorize.net is a payment gateway
\n* elavon -Elavon Virtual Merchant is a payment solution.
\n* paypal_pro -PayPal Pro Account is a payment gateway.
\n* orbital -Chase Paymentech(Orbital) is a payment gateway.
\n* paypal -PayPal Commerce is a payment gateway.
\n* beanstream -Bambora(formerly known as Beanstream) is a payment gateway.
\n* hdfc -HDFC Account is a payment gateway.
\n* ingenico_direct -Worldline Online Payments is a payment gateway.
\n* ogone -Ingenico ePayments (formerly known as Ogone) is a payment gateway.
\n* migs -MasterCard Internet Gateway Service payment gateway.
\n* stripe -Stripe is a payment gateway.
\n* vantiv -Vantiv is a payment gateway.
\n* moneris -Moneris is a payment gateway.
\n* bank_of_america -Bank of America Gateway
\n* chargebee -Chargebee test gateway.
\n* eway_rapid -eWAY Rapid is a payment gateway.
\n* gocardless -GoCardless is a payment service provider.
\n* mollie -Mollie is a payment gateway.
\n* paymill -PAYMILL is a payment gateway.
\n* balanced_payments -Balanced is a payment gateway
\n* solidgate -Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses.
\nThis feature is a Private Beta Release.
CyberSource is a payment gateway.
\n* ebanx -EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
\n", "enum" : [ "chargebee", "chargebee_payments", "adyen", "stripe", "wepay", "braintree", "authorize_net", "paypal_pro", "pin", "eway", "eway_rapid", "worldpay", "balanced_payments", "beanstream", "bluepay", "elavon", "first_data_global", "hdfc", "migs", "nmi", "ogone", "paymill", "paypal_payflow_pro", "sage_pay", "tco", "wirecard", "amazon_payments", "paypal_express_checkout", "gocardless", "orbital", "moneris_us", "moneris", "bluesnap", "cybersource", "vantiv", "checkout_com", "paypal", "ingenico_direct", "exact", "mollie", "quickbooks", "razorpay", "global_payments", "bank_of_america", "ecentric", "metrics_global", "windcave", "pay_com", "ebanx", "dlocal", "nuvei", "solidgate", "paystack", "jp_morgan", "deutsche_bank", "ezidebit", "twikey", "tempus", "moyasar", "payway", "not_applicable" ], "example" : null }, "payload" : { "type" : "string", "deprecated" : false, "description" : "Payload from the gateway response with voucher details\n", "maxLength" : 65000, "example" : null }, "error_code" : { "type" : "string", "deprecated" : false, "description" : "Error code received from the payment gateway on failure.\n", "maxLength" : 100, "example" : null }, "error_text" : { "type" : "string", "deprecated" : false, "description" : "Error message received from the payment gateway on failure.\n", "maxLength" : 65000, "example" : null }, "url" : { "type" : "string", "deprecated" : false, "description" : "Chargebee Hosted Page url for payment voucher\n", "maxLength" : 65000, "example" : null }, "date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates when this payment voucher occurred date.\n", "example" : null }, "resource_version" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
A Personalized Offer represents the best possible offer for a subscriber at a given moment in their lifecycle. It is generated by combining subscriber profile, subscription details, and contextual signals with the plays configured by Growth Managers in the Chargebee Growth dashboard. Learn more about Growth Solutions.\nGrowth Managers define strategic plays that guide customer engagement. Developers then use the Personalized Offers API to fetch and surface these offers within the subscriber experience; whether in an app, portal, checkout flow, websites or communications like email and SMS. Some common plays include:
Acquire: Incentivize trial users or prospects to subscribe.Expand: Encourage existing subscribers to purchase higher-value products or add-ons.Retain: Engage at-risk subscribers with targeted winbacks or discounts.Note: Growth solutions are currently in Early Access and available only for Chargebee Billing customers at no additional cost during the EAP period. This API is also part of the Early Access Program (EAP). To request access, go to the Chargebee Growth Early Access page in Chargebee Billing.
Features of this object
The Personalized Offers object enables you to:
The offer content to display to the user, includes title and description.
\nTip\nThe content is formatted in HTML and can be rendered safely in the DOM. However, the code may contain empty <div> elements of the form <div class="slate-p"></div>. Replace these with one or two newlines to preserve the intended line breaks.
Defines what happens after a customer accepts an offer and how the offer benefit is fulfilled. Learn more.
\n* email -Chargebee sends an email as configured in Growth, and the fulfillment is processed by your system.
\n* checkout -The offer is fulfilled by Chargebee via a Chargebee-hosted Checkout flow.
\n* webhook -Chargebee triggers webhook and fulfillment is processed by your system.
\n* url_redirect -Chargebee provides the redirect_url as configured in Growth, and the fulfillment is processed by your system.
The offer is fulfilled by Chargebee by applying the offer benefit directly to the subscription.
", "enum" : [ "billing_update", "checkout", "url_redirect", "webhook", "email" ], "example" : null }, "processing_layout" : { "type" : "string", "deprecated" : false, "description" : "Indicated the suggested UI flow for checkout type offers. Possible values: in_app or full_page.\n\\* in_app -\n\nUse an embedded checkout experience within the current interface.\n\\* full_page -\n\nRedirect the user to a dedicated full-page checkout.\n", "enum" : [ "in_app", "full_page" ], "example" : null }, "redirect_url" : { "type" : "string", "deprecated" : false, "description" : "A URL to which the user should be redirected. Returned only if the offer's processing type is 'url_redirect'\n", "maxLength" : 250, "example" : null } }, "required" : [ "id", "label", "processing_layout", "processing_type", "redirect_url" ], "example" : null }, "example" : null } }, "required" : [ "content", "id", "offer_id", "options" ], "example" : null }, "PortalSession" : { "type" : "object", "description" : "Customer Portal lets your customers to manage their account and billing themselves. Chargebee supports Single Sign-on (SSO) to access the customer portal. If you already have your own authentication for your website, it allows your authenticated customers to access their portal without having to login again.
Note: You can instead allow your customers to access the portal via login page provided by Chargebee. Read more.
Please follow the below steps for supporting portal access via SSO:
{your_website_url}/portal_link).Notes about access URL:
Note: This feature is not supported in in-app portal.\nChargebee allows you to integrate your website by building user authentication on top of Chargebee. You can also use the portal login to provide authenticated access for your customers to your website pages.\nWorkflow:\nUsers should be redirected to the portal login URL - https://yourdomain.chargebeeportal.com/portal/login by passing the following parameters:
Upon successful authentication, a session is created for the user and Chargebee redirects the user to the return_url along with the following parameters:
When Ramps are disabled, the customer can view and edit the single scheduled change if it exists.
\nWhen Ramps are enabled with compatibility mode:
\nchanges_scheduled_at parameter in the Update subscription API.For more details, see Ramps API compatibility mode.
\nThe variant_group\norganizes similar price_variants\nto optimize strategies such as bundling, geo-based pricing experiments, and campaign-specific pricing like cb-atomic-pricing-\nfor effective grouping. The variant_group\nprovides greater flexibility and precision in your pricing models.
Status of a price variant.
\n* active -Active price variant. This price variant can be attached to item prices\n.
\n* deleted -Deleted price variant. The id\nand name\nof the deleted price variant can be reused.
Archived price variant. This price variant is no longer active\nand cannot be attached to new item prices.\nExisting item prices that already have this price variant attached will continue to remain as is.
The version number of this resource. For every change made to the resource, resource_version\nis updated with a new timestamp in milliseconds.
The unique ID of the\nbusiness entity\nof this price_variant.\nThis is applicable only when multiple business entities have been created for the site. The value of this attribute indicates that the resource is specific to the given business entity.
The pricing_page_session\nresource allows you to create a pricing page that incorporates customer and subscription details. This page helps customers choose a plan, start a new subscription, or modify an existing one. Each session is distinct and has a limited duration, ensuring a unique and time-sensitive experience.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
Determines if the product is deleted or not. If the value is true\nthen the product has been deleted else it exists. Once the product is deleted, you can reuse the product id\nand name\n.
Deprecated\nThe purchase resource and its associated operations on this page are deprecated. Avoid using them in your integrations. The ability to purchase multiple plans in a single subscription will be supported through the Subscriptions API in the future.
The purchase resource represents a collection of item prices bought together. A purchase can contain one or more of the following:
subscription resource consists of item prices such that at least one of the item prices belongs to an item of type plan.)Prerequisite
Purchases must be enabled explicitly for the site. If not already enabled, contact eap@chargebee.com. Purchases require the following features to work so they're automatically enabled along with them:
Note
Once created, Chargebee never modifies a purchase resource; it cannot be modified via API either.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
country\nas XI.\nThat's the code for United Kingdom - Northern Ireland.\nThe first two characters of the VAT number in such a case is\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Specifies the contract term's end date. It indicates when the action set in action_at_term_end\ngets triggered.
Indicates that this resource has been deleted when the value is true\n.
Quantity of the recurring item\nwhich is represented by this line item. For metered\nline items, this value is updated from usages\nonce when the invoice is generated as pending\nand finally when the invoice is closed\n.
The decimal representation of the unit amount of the line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the amount for the line_item\n, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
Indicates whether the line item is for a metered item.If true\n, the item is metered; otherwise, it is non-metered.
The reason due to which the line item price/amount is exempted from tax.
\n* zero_value_item -If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.
\n* reverse_charge -If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
\n* tax_not_configured -If tax is not enabled for the site
\n* high_value_physical_goods -If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied
\n* tax_not_configured_external_provider -If the tax is not configured for the country in 3rd party tax provider.
\n* customer_exempt -If the Customer is marked as Tax exempt
\n* region_non_taxable -If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction
\n* product_exempt -If the Plan or Addon is marked as Tax exempt
\n* zero_rated -If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
\n* export -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* per_unit -Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The unique id of the line item that this deduction is for. Is required when discounts[entity_type]\nis item_level_coupon\nor document_level_coupon\n.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice.
\n* document_level_discount -The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The type of discount that is applied to the line item. Relevant only when discounts[entity_type]\nis one of item_level_discount\n, item_level_coupon\n, document_level_discount\n, or document_level_coupon
when percentage is applied as discount
\n* fixed_amount -when amount is applied as discount
", "enum" : [ "fixed_amount", "percentage" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "When the deduction is due to a coupon\nor a discount\n, then this is the id\nof the coupon or discount.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Quantity of the recurring item\nwhich is represented by this line item. For\nmetered\nline items, this value is updated from\nusages\nonce when the invoice is generated as\npending\nand finally when the invoice is\nclosed\n.
The decimal representation of the unit amount of the line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the amount for the line_item\n, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\n* reverse_charge -If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only
\n* tax_not_configured -If tax is not enabled for the site
\n* high_value_physical_goods -If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied
\n* product_exempt -If the Plan or Addon is marked as Tax exempt
\n* zero_rated -If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item
\n* customer_exempt -If the Customer is marked as Tax exempt
\n* region_non_taxable -If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction
\n* export -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
The type of deduction and the amount to which it is applied.
\n* item_level_coupon -The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
When the deduction is due to a\ncoupon\nor a\ndiscount\n, then this is the\nid\nof the coupon or discount.
The unique id of the line item that this deduction is for. Is required when discounts[entity_type]\nis item_level_coupon\nor document_level_coupon\n.
The type of deduction and the amount to which it is applied.
\n* document_level_coupon -The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a promotional credit\napplied to the invoice.
\n* document_level_discount -The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The type of discount that is applied to the line item. Relevant only when discounts[entity_type]\nis one of item_level_discount\n, item_level_coupon\n, document_level_discount\n, or document_level_coupon
when percentage is applied as discount
\n* fixed_amount -when amount is applied as discount
", "enum" : [ "fixed_amount", "percentage" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "When the deduction is due to a\ncoupon\nor a\ndiscount\n, then this is the\nid\nof the coupon or discount.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
When the\noperation_type\nof a\nquote\nis\nonetime_invoice\n, the\nquoted_charges\nresource contains the details of the invoice that is eventually created once the quote is invoiced. It is always returned along with the quote.
Specifies the service period of the charge in days. When the quote is converted, the invoice.line_item.date_from\nis set to current date/time and invoice.line_item.date_to\nis set to service_period_in_days\nahead of date_from\n.
The price or per-unit-price of the item price. By default, it is the value set\nfor the item_price.\nThis is only applicable when the pricing_model\nof the item_price\nis flat_fee\nor per_unit.\nThe value depends on the type of currency\n.
The pricing details of subscription_items\nwhich have pricing_model\nas tiered\n, volume\nor stairstep.\nLearn more\nabout pricing models.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
The index number of the subscription to which the item price is added. Provide a unique number between 0\nand 4\n(inclusive) for each subscription that is to be created.
The name of the discount as it should appear on customer-facing pages and documents such as invoices\nand hosted pages.\nThis is auto-generated based on the type\n, amount\n, and currency_code\nof the discount. For example, it can be 10% off\nor 10$ off\n.
The type of discount.\nPossible value are:
\n* offer_quantity -A specified number of units of the item price are offered for free. The number of free units is specified in quantity.\nThe offer_quantity\noption is valid only when apply_on\nis set to each_specified_item\nand the pricing_model\nof the item price is per_unit\n.
The specified percentage will be given as discount.
\n* fixed_amount -The specified amount will be given as discount.
", "enum" : [ "fixed_amount", "percentage", "offer_quantity" ], "example" : null }, "percentage" : { "type" : "number", "format" : "double", "deprecated" : false, "description" : "The percentage of the original amount that should be deducted from it.\n", "maximum" : 100, "minimum" : 0.01, "example" : null }, "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "minimum" : 0, "example" : null }, "quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Specifies the number of free units provided for the item, without affecting the total quantity sold. This parameter is applicable only when discount.type\nis offer_quantity.
The currency code (ISO 4217 format\n) of the discount. This is only applicable when discount.type\nis fixed_amount\n.
The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
The index number of the subscription to which the item price is added. Provide a unique number between 0\nand 4\n(inclusive) for each subscription that is to be created.
When a quote is created, it generates the quoted_ramps resource. This captures most of the details of the ramps that would eventually be created once the quote is invoiced. This resource is returned along with the quote for most of the associated operations.
Note\nApplicable only when Chargebee CPQ and Subscription Ramps are enabled. To request access, contact Chargebee Support.
The type of item. There must be one and only one item of type plan\nin this list.
Charge
\n* addon -Addon
\n* plan -Plan
", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The quantity of the item purchased\n", "minimum" : 1, "example" : null }, "quantity_in_decimal" : { "type" : "string", "deprecated" : false, "description" : "The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)\nis enabled.\n", "maxLength" : 33, "example" : null }, "unit_price" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency.
The total amount for the item as determined from unit_price\n, free_quantity\n, quantity\nand item_tiers\nas applicable. The value depends on the type of currency\n.
The interval between consecutive billing cycles for the subscription item. The interval is measured in the units defined by billing_period_unit\n.
The unit of measurement used to define the billing_period\nfor the subscription item.
A period of 7 days.
\n* year -A period of 1 calendar year.
\n* day -A period of 24 hours.
\n* month -A period of 1 calendar month.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "free_quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The free_quantity\nof the plan-item as specified\nfor the item price.
The free_quantity_in_decimal\nas set for the item price. Returned for quantity-based item prices when multi-decimal pricing\nis enabled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* contract_termination -when a contract term is terminated\n.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "charge_once" : { "type" : "boolean", "deprecated" : false, "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "start_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Specifies the start date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
Specifies the end date for the item price in the subscription. The period of the item price, determined by the start_date and end_date, specifies the ramp it belongs to.
The index or identifier of the ramp to which the item price belongs. This index is used to map item_tier[i] values to the correct ramp, as the target item_price of an item_tier may be part of multiple ramps.
Specifies the discount amount applied to a line item per billing cycle. This includes both item-level and invoice-level discounts.\nExample: Consider a monthly quote that includes a plan, an addon, a $50 discount on the plan, and an additional $100 invoice-level discount. In this case, discount_per_billing_cycle for the plan would be ($50 + $100 ÷ 2) = $100.
Specifies the discount amount applied to a line item per billing cycle, in decimal format. The value is expressed in the major currency units. This attribute is available only when Multi-Decimal Pricing is enabled.\nSee also:discount_per_billing_cycle.
Specifies the item-level discount amount applied to a line item per billing cycle. This does not include invoice-level discounts.\nExample: Consider a monthly quote that includes a plan, an addon, a $50 discount on the plan, and an additional $100 invoice-level discount. In this case, item_level_discount_per_billing_cycle for the plan would be $50.
Specifies the item-level discount amount applied to a line item per billing cycle, in decimal format. The value is expressed in the major currency units. This attribute is available only when Multi-Decimal Pricing is enabled.\nSee also:item_level_discount_per_billing_cycle.
Specifies the amount for this line item before discounts.\n**Example:**Consider a monthly quote that includes a $500 plan, an addon, a $50 discount on the plan, and an additional $100 invoice-level discount. In this case, amount_per_billing_cycle for the plan would be $500.
Specifies the amount for this line item before discounts, in decimal format. The value is expressed in the major currency units. This attribute is available only when Multi-Decimal Pricing is enabled.\nSee also:amount_per_billing_cycle.
Specifies the amount for this line item after discounts.\nExample: Consider a monthly quote that includes a $500 plan, an addon, a $50 discount on the plan, and an additional $100 invoice-level discount. In this case, net_amount_per_billing_cycle for the plan would be ($500 - ($50 + $100 ÷ 2)) = $400.
Specifies the amount for this line item after discounts, in decimal format. The value is expressed in the major currency units. This attribute is available only when Multi-Decimal Pricing is enabled.\nSee also:net_amount_per_billing_cycle.
The name of the discount as it should appear on customer-facing pages and documents such as invoices\nand hosted pages.\nThis is auto-generated based on the type\n, amount\n, and currency_code\nof the discount. For example, it can be 10% off\nor 10$ off\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "entity_type" : { "type" : "string", "deprecated" : false, "description" : "The type of deduction and the amount it applies to.
\n* document_level_coupon -The deduction comes from a coupon applied at the invoice level. The coupon id is available in the entity_id attribute.
The deduction comes from a coupon applied to a specific line item. The coupon id is available in the entity_id attribute.
The deduction comes from a discount applied to a specific line item. The discount id is available in the entity_id attribute.
The deduction comes from a discount applied at the invoice level. The discount id is available in the entity_id attribute.
When the deduction results from a coupon or a discount, this attribute contains the id of that coupon or discount.
The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "included_in_mrr" : { "type" : "boolean", "deprecated" : false, "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Specifies the start date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.
Specifies the end date for the discount. The period of the discount, as specified by the start_date and end_date determines the ramp(s) it will be part of.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
The index or identifier of the ramp to which this tier information belongs. This is a value from the line_items[i].ramp_tier_id. Since an item price can be part of multiple subscriptions ramps, this group ID specifies the ramp to which this tier information belongs.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20, consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
When a quote is created, it generates the quoted_subscription resource. This captures most of the details of the subscription that would eventually be created once the quote is invoiced. This resource is returned along with the quote for most of the associated operations.
Applicable only when operation_type\nof the quote is create_subscription_for_customer.\nFor subscriptions in the future\nstatus\n, this is the date/time when the subscription is set to start. The quote can be converted on a date/time after this date. This is called backdating the subscription creation. Backdating is performed when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:
start_date cannot be earlier than 14th February.Applicable only when operation_type\nof the quote is change_subscription.\nWhen change_option\nis set to specific_date\n, then this is the date/time at which the subscription change is scheduled to occur. The quote can be converted on a date/time after this date. This is called backdating the subscription change and performed when the subscription change has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:
Backdating must be enabled for subscription change operations.
\nOnly the following changes can be backdated:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nSubscription status is active, cancelled, or non_renewing.
The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
\nThe date is on or after current_term_start.
The date is on or after the last date/time any of the following changes were made:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nThe date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the subscription's plan is 2 months and today is 14th April, changes_scheduled_at cannot be earlier than 14th February.
Applicable only when operation_type\nof the quote is change_subscription.\nWhen the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
The change is scheduled to be carried out at the end of the billing cycle of the subscription.
\n* specific_date -The change is carried out as of changes_scheduled_at\n.
The change is carried out immediately upon quote conversion.
", "enum" : [ "end_of_term", "specific_date", "immediately" ], "example" : null }, "free_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The period of time by which the first term of the subscription is extended free of charge. The value is expressed in the time unit specified by free_period_unit. For example, 3 with free_period_unit = month means 3 free months are added to the first term.
Constraints
operation_type is create_subscription_for_customer.The time unit for free_period.
Constraints
operation_type is create_subscription_for_customer.Charge based on week(s)
\n* month -Charge based on month(s)
\n* day -Charge based on day(s)
\n* year -Charge based on year(s)
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "contract_term_billing_cycle_on_renewal" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
The name of the discount as it should appear on customer-facing pages and documents such as invoices\nand hosted pages.\nThis is auto-generated based on the type\n, amount\n, and currency_code\nof the discount. For example, it can be 10% off\nor 10$ off\n.
The type of discount.\nPossible value are:
\n* fixed_amount -The specified amount will be given as discount.
\n* offer_quantity -A specified number of units of the item price are offered for free. The number of free units is specified in quantity.\nThe offer_quantity\noption is valid only when apply_on\nis set to each_specified_item\nand the pricing_model\nof the item price is per_unit\n.
The specified percentage will be given as discount.
", "enum" : [ "fixed_amount", "percentage", "offer_quantity" ], "example" : null }, "percentage" : { "type" : "number", "format" : "double", "deprecated" : false, "description" : "The percentage of the original amount that should be deducted from it.\n", "maximum" : 100, "minimum" : 0.01, "example" : null }, "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "minimum" : 0, "example" : null }, "quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Specifies the number of free units provided for the item, without affecting the total quantity sold. This parameter is applicable only when discount.type\nis offer_quantity.
The currency code (ISO 4217 format\n) of the discount. This is only applicable when discount.type\nis fixed_amount\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "included_in_mrr" : { "type" : "boolean", "deprecated" : false, "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for limited_period\nduration type discount.
Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
The index number of the subscription to which the item price is added. Provide a unique number between 0\nand 4\n(inclusive) for each subscription that is to be created.
The type of item. There must be one and only one item of type plan\nin this list.
Plan
\n* charge -Charge
\n* addon -Addon
", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The quantity of the item purchased\n", "minimum" : 1, "example" : null }, "quantity_in_decimal" : { "type" : "string", "deprecated" : false, "description" : "The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)\nis enabled.\n", "maxLength" : 33, "example" : null }, "unit_price" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency. If changes_scheduled_at\nis in the past and a unit_price\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
The total amount for the item as determined from unit_price\n, free_quantity\n, quantity\nand item_tiers\nas applicable. The value depends on the type of currency\n.
The date or time at when the next billing for the item is scheduled to occur. This typically occurs immediately after current_term_end.
Note\nApplicable only when multi-frequency billing is enabled.
Private Beta\nMulti-frequency billing is in private beta. Please reach out to the Chargebee support to enable this feature.
The interval between consecutive billing cycles for the subscription item. The interval is measured in the units defined by billing_period_unit\n.
The unit of measurement used to define the billing_period\nfor the subscription item.
A period of 1 calendar year.
\n* week -A period of 7 days.
\n* day -A period of 24 hours.
\n* month -A period of 1 calendar month.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "free_quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The free_quantity\nof the plan-item as specified\nfor the item price.
The free_quantity_in_decimal\nas set for the item price. Returned for quantity-based item prices when multi-decimal pricing\nis enabled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "charge_once" : { "type" : "boolean", "deprecated" : false, "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "proration_type" : { "type" : "string", "deprecated" : false, "description" : "null\n", "enum" : [ "full_term", "partial_term", "none" ], "example" : null }, "usage_accumulation_reset_frequency" : { "type" : "string", "deprecated" : false, "description" : "null\n", "enum" : [ "never", "subscription_billing_frequency" ], "example" : null } }, "required" : [ "item_price_id", "item_type" ], "example" : null }, "example" : null }, "item_tiers" : { "type" : "array", "deprecated" : false, "description" : "List of item tier.\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "item_price_id" : { "type" : "string", "deprecated" : false, "description" : "The id of the item price to which this tier belongs.\n", "maxLength" : 100, "example" : null }, "starting_unit" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The lowest value in the quantity tier.\n", "minimum" : 1, "example" : null }, "ending_unit" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The highest value in the quantity tier.\n", "example" : null }, "price" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
The index number of the subscription to which the item price is added. Provide a unique number between 0\nand 4\n(inclusive) for each subscription that is to be created.
Action to be taken when the contract term completes.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
\n* evergreen -Contract term completes and the subscription renews.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "total_contract_value" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "The sum of the totals\nof all the invoices raised as part of the contract term. For active\ncontract terms, this is a predicted value. The value depends on the type of currency.\nIf the subscription was imported\nwith the contract term, then this value includes the value passed for total_amount_raised\n.
The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
A ramp resource, or subscription ramp, represents a planned change to a subscription that occurs at a future date. Use this resource to define and schedule subscription modifications, such as updating pricing, altering quantity, or transitioning to a different plan, without immediately applying them.
Note
status as scheduled.When you create or update a ramp, Chargebee automatically moves any existing ramps scheduled after that ramp to draft status if either of the following conditions is met:
subscription_items[i].billing_periodsubscription_items[i].billing_period_uniti is the index where subscription_items[i].item_type is plan.The execution status of the ramp
\n* succeeded -The ramp completed successfully.
\n* scheduled -The ramp has been created and scheduled for execution.
\nNote\nExcluding deleted ramps, a subscription can have a maximum of 12 ramps in the scheduled status.
The ramp is moved to draft\nstatus when the associated subscription is updated. The reason for the draft status can be explained in the status_transition_reason
Note\nRamps in draft state will not be executed.
The ramp did not complete because of an error.
", "enum" : [ "scheduled", "succeeded", "failed", "draft" ], "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp indicating when this resource was created.\n", "example" : null }, "resource_version" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource.
Indicates if the ramp is marked as deleted. To retrieve deleted ramps, use the List subscription ramps\nendpoint with include_deleted\nset to true\n.
The type of item. There must be one and only one item of type plan\nin this list.
Charge
\n* plan -Plan
\n* addon -Addon
", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The quantity of the item purchased\n", "minimum" : 1, "example" : null }, "quantity_in_decimal" : { "type" : "string", "deprecated" : false, "description" : "The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies)\nis enabled.\n", "maxLength" : 33, "example" : null }, "unit_price" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency\n.
The total amount for the item as determined from unit_price\n, free_quantity\n, quantity\nand item_tiers\nas applicable. The value depends on the type of currency\n.
The quantity of the item price that is available for free. Only the quantity more than this will be charged for the subscription. This is the same as item_price.free_quantity\n.
The free_quantity_in_decimal\nas set for the item price. Returned for quantity-based item prices when multi-decimal pricing\nis enabled.
Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* immediately -The item is charged immediately on being added to the subscription.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* contract_termination -when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
The type of item. There must be one and only one item of type plan\nin this list.
Charge
\n* plan -Plan
\n* addon -Addon
", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The quantity of the item purchased\n", "minimum" : 1, "example" : null }, "quantity_in_decimal" : { "type" : "string", "deprecated" : false, "description" : "The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)\nis enabled.\n", "maxLength" : 33, "example" : null }, "unit_price" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency\n.
The total amount for the item as determined from unit_price\n, free_quantity\n, quantity\nand item_tiers\nas applicable. The value depends on the type of currency\n.
The quantity of the item price that is available for free. Only the quantity more than this will be charged for the subscription. This is the same as item_price.free_quantity\n..
The free_quantity_in_decimal\nas set for the item price. Returned for quantity-based item prices when multi-decimal pricing\nis enabled.
Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
The item is charged immediately on being added to the subscription.
", "enum" : [ "immediately", "on_event" ], "example" : null }, "charge_on_event" : { "type" : "string", "deprecated" : false, "description" : "When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time when the trial period of the subscription begins.
\n* plan_activation -same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
", "enum" : [ "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null } }, "required" : [ "item_price_id", "item_type" ], "example" : null }, "example" : null }, "coupons_to_add" : { "type" : "array", "deprecated" : false, "description" : "Details about the [coupons](/docs/api/coupons)\nadded to the subscription through this ramp.\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "coupon_id" : { "type" : "string", "deprecated" : false, "description" : "Unique ID of the coupon to be added.\n", "maxLength" : 100, "example" : null }, "apply_till" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The date till when the coupon can be applied. Applicable for limited_period\ncoupons\nonly.
The name of the discount as it should appear on customer-facing pages and documents such as invoices\nand hosted pages.\nThis is auto-generated based on the type\n, amount\n, and currency_code\nof the discount. For example, it can be 10% off\nor 10$ off\n.
The percentage of the original amount that should be deducted from it. Only applicable when discount.type\nis percentage.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 7 days.
\n* year -A period of 1 calendar year.
\n* day -A period of 24 hours.
\n* month -A period of 1 calendar month.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "included_in_mrr" : { "type" : "boolean", "deprecated" : false, "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Note\nAllowed only when both of these conditions are met:
pricing_model of the item price is either tiered, volume, or stairstep.Overrides the item_tiers for specific item_prices of the subscription.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -renewal_billing_cycles.action_at_term_end for the new contract term is set to renew.Used when you want to renew the contract term just once. Does the following:
\nrenewal_billing_cycles.action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null } }, "required" : [ "action_at_term_end" ], "example" : null }, "status_transition_reason" : { "type" : "object", "deprecated" : false, "description" : "Detailed reason for the status transition of a ramp to draft\nand failed\nstatus.
Unique code of the status_transition_reason\n.
A message to explain the status_transition_reason\n.
Important
The recorded purchase resource represents a background job of syncing in-app purchases made through external storefronts like Apple and Google with Chargebee. The status (in_process, completed, and failed) attribute represents the current status of the background job.
You can record in-app subscription purchases made on the Apple App Store in Chargebee using the transaction[id] or using receipt and product[id] received after a successful purchase.
To record the purchase and retrieve subscription details, follow these steps:
Use the Record a Purchase API to record a subscription purchase made in in Apple App Store or Google Play Store.
\nRecord an Apple App Store purchase using transaction id with the app_id, customer[id] and transaction[id].
Record an Apple App Store purchase using receipt with the app_id, customer[id], receipt and product[id].
Record a Google Play Store one time order or subscription purchase with the app_id, customer[id] and order_id (Recommended).
Record a Google Play Store subscription purchase with the app_id, customer[id] and purchase_token.
Record a Google Play Store one time order purchase with the app_id, customer[id], purchase_token and product_id.
The API response will include a recorded_purchase object containing the status of the purchase recording job.
Once the purchase is successfully recorded, the status attribute of the recorded_purchase object updates from in_process to completed. At this point, Chargebee creates an omnichannel_subscription resource and triggers an omnichannel_subscription_created webhook event, which contains the omnichannel_subscription and omnichannel_transaction objects.
In addition to using Webhooks (push-based), you can retrieve details for a recorded purchase by using the recorded purchase resource's ID, which is returned when you record the purchase.
\nThe id\nof the customer\nobject that is associated with this purchase. If the customer_id\nis not present in Chargebee when the record_a_purchase\nAPI request is made, the API will return an error. Use create_a_customer\nAPI to create a customer.
App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
Current status of the recorded purchase operation
\n* completed -When the purchase recording job status is complete. You will receive the omnichannel_transaction_id\nand linked_omnichannel_subscriptions\nobject.
When the purchase recording job is initiated for an omnichannel subscription that already exists in Chargebee.
\n* failed -When the purchase recording job is failed. In this state you will not\nreceive the omnichannel_transaction_id\nand linked_omnichannel_subscriptions\nobject. Check the error_detail\nattribute to understand the reason for failure.
When the purchase recording job is in progress. In this state you will not\nreceive the omnichannel_transaction_id\nand linked_omnichannel_subscriptions\nobject.
The id\nof the omni transaction\nobject associated with the purchase.
Indicates timestamp when the recorded_purchase\nresource is created in Chargebee.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource.
The id\nof the omni subscription\nobject associated with this purchase.
The id\nof the omni one time order\nobject associated with this purchase.
Applicable only for recorded purchases where the job status is failed.\nIt provides more details about the failure.
A descriptive information about the error_detail\n.
The type\nof the item
Charge
\n* plan -Plan
\n* addon -Addon
", "enum" : [ "plan", "addon", "charge", "plan_price", "addon_price" ], "example" : null }, "count" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Number of items.\n", "example" : null } }, "example" : null }, "ReferralSystem" : { "type" : "string", "deprecated" : false, "enum" : [ "referral_candy", "referral_saasquatch", "friendbuy" ], "example" : null }, "ReferrerRewardType" : { "type" : "string", "deprecated" : false, "enum" : [ "none", "referral_direct_reward", "custom_promotional_credit", "custom_revenue_percent_based" ], "example" : null }, "RefundInitiatedEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the event\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "example" : null }, "content" : { "type" : "object", "properties" : { "transaction" : { "$ref" : "#/components/schemas/Transaction" }, "invoice" : { "$ref" : "#/components/schemas/Invoice" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote" }, "customer" : { "$ref" : "#/components/schemas/Customer" }, "subscription" : { "$ref" : "#/components/schemas/Subscription" }, "card" : { "$ref" : "#/components/schemas/Card" } }, "required" : [ "card", "credit_note", "customer", "invoice", "subscription", "transaction" ], "example" : null } }, "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ], "example" : null }, "RefundableCreditsHandling" : { "type" : "string", "deprecated" : false, "enum" : [ "no_action", "schedule_refund" ], "example" : null }, "ReportBy" : { "type" : "string", "deprecated" : false, "enum" : [ "customer", "invoice", "product", "subscription" ], "example" : null }, "ResourceMigration" : { "type" : "object", "description" : "Resource Migration is used for finding the status of customer migration between Chargebee sites.\n", "properties" : { "from_site" : { "type" : "string", "deprecated" : false, "description" : "Domain name to which the item is moved.\n", "maxLength" : 50, "minLength" : 4, "example" : null }, "entity_type" : { "type" : "string", "deprecated" : false, "description" : "Type of the entity this record is stored for\n\\* customer -\n\nEntity that represents a customer\n", "enum" : [ "customer" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "Handle of the customer in the current site.\n", "maxLength" : 100, "example" : null }, "status" : { "type" : "string", "default" : "failed", "deprecated" : false, "description" : "Status of the copy customer process.\n\\* failed -\n\nFailed\n\\* succeeded -\n\nSucceeded\n\\* scheduled -\n\nScheduled\n", "enum" : [ "scheduled", "failed", "succeeded" ], "example" : null }, "errors" : { "type" : "string", "deprecated" : false, "description" : "Filled only if the copy operation gets failed\n", "maxLength" : 65000, "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Time the log is created\n", "example" : null }, "updated_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Time the log is updated\n", "example" : null } }, "required" : [ "created_at", "entity_id", "entity_type", "from_site", "status", "updated_at" ], "example" : null }, "ResponseDocumentType" : { "type" : "string", "deprecated" : false, "enum" : [ "application_response" ], "example" : null }, "ResponseStatus" : { "type" : "string", "deprecated" : false, "enum" : [ "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ], "example" : null }, "ResumeOption" : { "type" : "string", "deprecated" : false, "enum" : [ "immediately", "specific_date" ], "example" : null }, "RetryEngine" : { "type" : "string", "default" : "chargebee", "deprecated" : false, "enum" : [ "chargebee", "flexpay", "successplus" ], "example" : null }, "Role" : { "type" : "string", "deprecated" : false, "enum" : [ "primary", "backup", "none" ], "example" : null }, "Rule" : { "type" : "object", "properties" : { "id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "namespace" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "rule_name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "rule_order" : { "type" : "integer", "format" : "int32", "deprecated" : false, "example" : null }, "status" : { "type" : "string", "deprecated" : false, "enum" : [ "active", "disabled" ], "example" : null }, "conditions" : { "type" : "string", "deprecated" : false, "maxLength" : 65000, "example" : null }, "outcome" : { "type" : "string", "deprecated" : false, "maxLength" : 65000, "example" : null }, "deleted" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "modified_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null } }, "required" : [ "created_at", "deleted", "id", "modified_at", "namespace", "rule_name", "status" ], "example" : null }, "RuleCreatedEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the event\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "example" : null }, "content" : { "type" : "object", "properties" : { "rule" : { "$ref" : "#/components/schemas/Rule" } }, "required" : [ "rule" ], "example" : null } }, "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ], "example" : null }, "RuleDeletedEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the event\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "example" : null }, "content" : { "type" : "object", "properties" : { "rule" : { "$ref" : "#/components/schemas/Rule" } }, "required" : [ "rule" ], "example" : null } }, "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ], "example" : null }, "RuleUpdatedEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the event\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "example" : null }, "content" : { "type" : "object", "properties" : { "rule" : { "$ref" : "#/components/schemas/Rule" } }, "required" : [ "rule" ], "example" : null } }, "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ], "example" : null }, "Ruleset" : { "type" : "object", "properties" : { "id" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "name" : { "type" : "string", "deprecated" : false, "maxLength" : 500, "example" : null }, "description" : { "type" : "string", "deprecated" : false, "maxLength" : 65000, "example" : null }, "active" : { "type" : "boolean", "deprecated" : false, "example" : null }, "execute_mode" : { "type" : "string", "default" : "execute_all", "deprecated" : false, "enum" : [ "stop_on_first_true", "stop_on_first_false", "execute_all", "execute_all_true" ], "example" : null }, "updated_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "created_by" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "rules" : { "type" : "array", "deprecated" : false, "items" : { "example" : null }, "example" : null } }, "required" : [ "active", "created_at", "created_by", "execute_mode", "id", "name", "updated_at" ], "example" : null }, "RulesetRule" : { "type" : "object", "properties" : { "rule_id" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "priority" : { "type" : "integer", "format" : "int32", "deprecated" : false, "example" : null } }, "required" : [ "priority", "rule_id" ], "example" : null }, "SalesOrder" : { "type" : "object", "description" : "Sales orders represent the contractual agreement and commitment for services between a seller and a buyer. They act as a seamless interface connecting any sales system (such as CPQ, CRM, or Customer Portal) with Chargebee Billing. The sales order captures the following essential components\n\n* Order Line Items including discounts and ramps\n* Billing and payment configuration\n* Contract terms and conditions\n* Customer information including billing and shipping contacts\n* Meta data\n", "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "External identifier of the sales order.\n", "maxLength" : 50, "example" : null }, "version" : { "type" : "integer", "format" : "int32", "default" : 1, "deprecated" : false, "description" : "Version of the sales order.\n", "example" : null }, "renewed_from_order_id" : { "type" : "string", "deprecated" : false, "description" : "The unique identifier of the original sales order from which this order was renewed. This field is used to track renewal orders and link them to their previous sales transactions.\n", "maxLength" : 50, "example" : null }, "updated_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates the timestamp at which this sales order was last updated.\n", "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp indicating sales order created.\n", "example" : null }, "po_number" : { "type" : "string", "deprecated" : false, "description" : "Buyer's purchase order reference number.\n", "maxLength" : 100, "example" : null }, "meta_data" : { "type" : "string", "deprecated" : false, "description" : "A set of key-value pairs stored as additional information for the subscription. [Learn more](/docs/api/sales_orders)\n.\n", "maxLength" : 65000, "example" : null }, "quote_id" : { "type" : "string", "deprecated" : false, "description" : "Primary quote id for which the order was placed.\n", "maxLength" : 100, "example" : null }, "effective_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Effective start date of the order signifies when the contract is signed and becomes legally binding.\n", "example" : null }, "end_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The date when the order is considered completed, cancelled, or no longer valid.\n", "example" : null }, "business_entity_id" : { "type" : "string", "deprecated" : false, "description" : "The unique ID of the\n[business entity](/docs/api/getting-started)\nof this sales order.\n", "maxLength" : 50, "example" : null }, "customer_id" : { "type" : "string", "deprecated" : false, "description" : "The unique ID of the customer to which this sales order belongs.\n", "maxLength" : 50, "example" : null }, "subscription_id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "The currency code (ISO 4217 format) of the sales order.\n", "maxLength" : 3, "example" : null }, "subscription_ids" : { "type" : "array", "deprecated" : false, "description" : "The unique identifiers of the [subscriptions](/docs/api/subscriptions)\nthat are bundled as part of this sales order.\n", "items" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "example" : null }, "status" : { "type" : "string", "default" : "active", "deprecated" : false, "description" : "Status of the sales order.\n\\* completed -\n\ncompleted\n\\* active -\n\nactive\n", "enum" : [ "active", "completed" ], "example" : null }, "deleted" : { "type" : "boolean", "deprecated" : false, "example" : null }, "line_items" : { "type" : "array", "deprecated" : false, "description" : "Line items of this sales order\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "External identifier of the sales order line item.\n", "maxLength" : 50, "example" : null }, "association_id" : { "type" : "string", "deprecated" : false, "description" : "A reference of line item to associate with other entities like line item tiers.\n", "maxLength" : 105, "example" : null }, "item_price_id" : { "type" : "string", "deprecated" : false, "description" : "ID of the item price.\n", "maxLength" : 100, "example" : null }, "name" : { "type" : "string", "deprecated" : false, "description" : "Name of the item.\n", "maxLength" : 100, "example" : null }, "quantity" : { "type" : "string", "default" : "1", "deprecated" : false, "description" : "Quantity of the item.\n", "maxLength" : 39, "example" : null }, "unit_price" : { "type" : "string", "deprecated" : false, "description" : "Unit price of the item.\n", "maxLength" : 39, "example" : null }, "billable_unit_price" : { "type" : "string", "deprecated" : false, "maxLength" : 39, "example" : null }, "billable_quantity" : { "type" : "string", "deprecated" : false, "maxLength" : 39, "example" : null }, "billable_amount" : { "type" : "string", "deprecated" : false, "maxLength" : 39, "example" : null }, "billing_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Defines billing period for the subscription item\n", "minimum" : 1, "example" : null }, "billing_period_unit" : { "type" : "string", "deprecated" : false, "description" : "Defines billing period unit in association with the billing period.\n\\* week -\n\nA period of 7 days.\n\\* year -\n\nA period of 1 calendar year.\n\\* day -\n\nA period of 24 hours.\n\\* month -\n\nA period of 1 calendar month.\n", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "service_period_days" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The service period of the item in days from the day of charge.\n", "maximum" : 730, "minimum" : 1, "example" : null }, "charge_on_event" : { "type" : "string", "deprecated" : false, "description" : "When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* contract_termination -when a contract term is terminated\n.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "charge_once" : { "type" : "boolean", "deprecated" : false, "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The name of the discount as it should appear on customer-facing pages and documents such as invoices\nand hosted pages.\nThis is auto-generated based on the type\n, amount\n, and currency_code\nof the discount. For example, it can be 10% off\nor 10$ off\n.
The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* forever -The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "percentage" : { "type" : "number", "format" : "double", "deprecated" : false, "description" : "The percentage of the original amount that should be deducted from it. Only applicable when discount.type\nis percentage.
The value of the discount. The format of this value\ndepends on the kind of currency. This is only applicable when discount.type\nis fixed_amount.
The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 24 hours.
\n* week -A period of 7 days.
\n* month -A period of 1 calendar month.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "item_price_id" : { "type" : "string", "deprecated" : false, "description" : "The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The pricing details of line_items\nwhich have pricing_model\nas tiered\n, volume\nor stairstep.\nLearn more\nabout pricing models.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
Pricing type for the tier.
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
Setting this attribute to true would invoice the overages for the metered item during subscription changes
The action at end of contract term
\n* cancel -Contract term completes and subscription is canceled.
\n* renew -renewal_billing_cycles.end_of_term_action for the new contract term is set to renew.Contract term completes and the subscription renews.
", "enum" : [ "renew", "cancel", "evergreen" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of days before contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.\n", "example" : null }, "renewal_billing_cycles" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Specifies the number of billing cycles for which the contract will be renewed.\n", "example" : null } }, "required" : [ "end_of_term_action" ], "example" : null }, "credit_lines" : { "type" : "array", "deprecated" : false, "items" : { "type" : "object", "deprecated" : false, "properties" : { "amount" : { "type" : "string", "deprecated" : false, "maxLength" : 39, "example" : null }, "unit_price" : { "type" : "string", "default" : "0.00", "deprecated" : false, "maxLength" : 39, "example" : null }, "quantity" : { "type" : "string", "deprecated" : false, "maxLength" : 33, "example" : null }, "line_item_association_id" : { "type" : "string", "deprecated" : false, "maxLength" : 105, "example" : null } }, "required" : [ "amount", "unit_price" ], "example" : null }, "example" : null }, "entitlement_overrides" : { "type" : "array", "deprecated" : false, "items" : { "type" : "object", "deprecated" : false, "properties" : { "id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "feature_id" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "entity_type" : { "type" : "string", "deprecated" : false, "description" : "null\n", "enum" : [ "item_price", "subscription" ], "example" : null }, "value" : { "type" : "string", "deprecated" : false, "maxLength" : 39, "example" : null }, "is_enabled" : { "type" : "boolean", "default" : true, "deprecated" : false, "example" : null }, "start_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "end_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null } }, "required" : [ "entity_id", "entity_type", "feature_id", "id", "is_enabled", "start_date" ], "example" : null }, "example" : null } }, "required" : [ "created_at", "currency_code", "customer_id", "deleted", "effective_date", "id", "status", "subscription_id", "version" ], "example" : null }, "SalesOrderCreatedEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the event\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "example" : null }, "content" : { "type" : "object", "properties" : { "sales_order" : { "$ref" : "#/components/schemas/SalesOrder" } }, "required" : [ "sales_order" ], "example" : null } }, "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ], "example" : null }, "SalesOrderUpdatedEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the event\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "example" : null }, "content" : { "type" : "object", "properties" : { "sales_order" : { "$ref" : "#/components/schemas/SalesOrder" } }, "required" : [ "sales_order" ], "example" : null } }, "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ], "example" : null }, "ScheduleType" : { "type" : "string", "deprecated" : false, "enum" : [ "immediate", "specific_dates", "fixed_intervals" ], "example" : null }, "SiteMigrationDetail" : { "type" : "object", "description" : "Site Migration details is used for finding the records that are moved in and moved out from one Chargebee site to another.\n", "properties" : { "entity_id" : { "type" : "string", "deprecated" : false, "description" : "Id of the entity in this site.\n", "maxLength" : 100, "example" : null }, "other_site_name" : { "type" : "string", "deprecated" : false, "description" : "Site name to which the record is moved in/out.\n", "maxLength" : 50, "minLength" : 4, "example" : null }, "entity_id_at_other_site" : { "type" : "string", "deprecated" : false, "description" : "Entity Id of the record in the other site.\n", "maxLength" : 100, "example" : null }, "migrated_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Date in which the record is copied\n", "example" : null }, "entity_type" : { "type" : "string", "deprecated" : false, "description" : "Entity Type of the record\n\\* order -\n\nEntity that represents an order\n\\* customer -\n\nEntity that represents a customer\n\\* invoice -\n\nInvoice description\n\\* subscription -\n\nEntity that represents a subscription of a customer\n\\* transaction -\n\nEntity that represents a transaction.\n\\* credit_note -\n\nCredit note description\n", "enum" : [ "customer", "subscription", "invoice", "credit_note", "transaction", "order" ], "example" : null }, "status" : { "type" : "string", "deprecated" : false, "description" : "Status of the migration\n\\* moving_out -\n\nMoving out from one cb site to another\n\\* moved_in -\n\nMoved in from another cb site\n\\* moved_out -\n\nMoved out from one cb site to another\n", "enum" : [ "moved_in", "moved_out", "moving_out" ], "example" : null } }, "required" : [ "entity_id", "entity_id_at_other_site", "entity_type", "migrated_at", "other_site_name", "status" ], "example" : null }, "SiteOwner" : { "type" : "object", "description" : "Represents a site owner in Chargebee.\nEach site owner includes a unique id and required email, and can optionally include name, customer_id, and updated_at.
A Chargebee subscription connects a customer record to products/services. It describes what the customer has signed up for and how often they're charged for it. The essential components of a subscription are:
The charges in a subscription are billed via invoices.
Chargebee offers two billing frequency options for subscriptions:
Plan-based billing (default): Subscriptions are billed based on the billing period defined for the item price of the item_type plan. Learn more.
Multi-frequency billing: Subscriptions are billed according to the billing period of each recurring item price within the subscription. Learn more.
\nImportant
Limitations of Multi-frequency billing.
Private Beta
Multi-frequency billing is in private beta. Please reach out to the Chargebee support to enable this feature.
The selection of the billing frequency preference is configured at the site level.
When creating or updating a subscription, one of the item prices specified under subscription_items must be a plan-item price. The remaining must be compatible addon- or charge-item prices. An item price is compatible with a plan-item price if their currencies are the same. Additionally, an addon-item price is compatible with a plan-item price only if their billing frequencies meet the following conditions:
period_unit for plan-item price | Compatible period_unit for addon-item price | Compatible period for addon-item price |
|---|---|---|
day | day | The Example If the |
week | week or day | The Example\nIf the
|
month | month | The Example If the |
year | year or month | The Example If the
|
Avalara: Merchants using Avalara Sales Tax can optionally associate each item price with a locationCode (from their Avalara company locations), so tax can be resolved correctly at the line item level.
| Field ID | Field Value | APIs |
|---|---|---|
locationCode | Merchant to configure it on Avalara Platform under company locations | APIs having Item Prices attributes. |
Anrok: Canadian customers can have multiple tax registration numbers. We currently support only sharing one tax registration number with Anrok. So we added a new field which can have comma separated multiple tax reg numbers for Anrok. Values configured in the field is passed as it is to Anrok for accurate tax calculation
| Field ID | Field Value | APIs |
|---|---|---|
additionalTaxRegistrationNumber | Canadian tax registration numbers in comma separated fashion. | APIs involving customer attributes. Also includes APIs where we are creating new customers. Eg: estimate, subscription, hosted pages. |
Vertex: Chargebee shares field IDs and corresponding values with merchants, who then configure them on the Vertex Platform for seamless integration
Note:\nField Id like customerCode\n, customerClass\n, andtaxExempted\nbelong to the customer object.
Field Id like productCode\n, productClass\n, productTaxCode\n, and productClass\nbelong to the product object.
| Field ID | Field Value | APIs |
|---|---|---|
productCode | Merchant to configure it on Vertex Platform | APIs having Item Prices attributes. |
productClass | ||
customerCode | APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages. | |
customerClass |
Taxamo: Chargebee shares field IDs and corresponding values with merchants, who then configure them on the Taxamo Platform for seamless integration
| Field Id | Field Value | APIs |
|---|---|---|
productTaxCode | Merchant to configure it on Taxamo Platform | APIs having Item Prices attributes. |
productClass | ||
taxExempted | APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages. |
cbtaxes: With CBTaxes, you can activate India IGST for customers located in Special Economic Zones (SEZ), implement zero-rated tax for SEZ customers, enable India IGST for customers outside of India, and set up zero-rated tax for customers outside of India.
| Field ID | Field Value | APIs |
|---|---|---|
indiaSez | SEZ_IGST_TAX | APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages. |
SEZ_ZERO_RATED_TAX | ||
indiaExport | EXPORT_IGST_TAX | |
EXPORT_ZERO_RATED_TAX |
All: For tax inclusive tax calculation, For tax exclusive tax calculation. This is currently used for price type overriding at customer level
| Field ID | Field Value | APIs |
|---|---|---|
priceType | TAX_INCLUSIVE | APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages. |
TAX_EXCLUSIVE | ||
SITE_DEFAULT or blank | Removes price type override, and allows site level configuration to be used for tax calculation. |
If you want to schedule changes on a subscription, use the Ramps API.
If you are currently scheduling changes through the Update subscription API, migrate to the Ramps API. To get started, request access for Subscription Ramps. Chargebee will enable Ramps compatibility mode for your site. Once enabled, you can test the Ramps API without impacting your existing integrations.
The following parts of the Billing API have subtle differences in behavior when the Ramps feature is disabled versus when it is enabled with compatibility mode. (Follow the links to learn more.)
The unique identifier of the subscription\nresource. You have the option to specify this value when creating a customer. If not specified, Chargebee automatically generates a unique identifier.
Note\nIn the event that the subscription resource is transferred along with its associated customer resource to a different business entity, Chargebee assigns a new random value as the id for the subscription. The original identifier is preserved for the transferred copy of the subscription resource. (See also: Mechanics of business entity transfer.)
Specifies the length of each billing cycle (or term) of the subscription, expressed in the unit defined by billing_period_unit.
Specifies the unit used to measure the billing_period.
Current state of the subscription
\n* future -The subscription is scheduled to start at a future date.
\n* non_renewing -The subscription will be canceled at the end of the current term.
\n* active -The subscription is active and will be charged for automatically based on the items in it.
\n* cancelled -The subscription has been canceled and is no longer in service.
\n* transferred -The transferred\nstatus will be reflected on the source business entity's subscription attribute once the customer transfer\nactivity is completed successfully.
The subscription is in trial.
\n* paused -The subscription is paused.\nThe subscription will not renew while in this state.
", "enum" : [ "future", "in_trial", "active", "non_renewing", "paused", "cancelled", "transferred" ], "example" : null }, "trial_start" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Start of the trial period for the subscription. Presence of this value for future\nsubscription implies the subscription will go into in_trial\nstate when it starts.
The date/time at which the next billing for the subscription happens. This is usually right after current_term_end\nunless multiple subscription terms were invoiced in advance using the terms_to_charge\nparameter.
Time at which the subscription was started. Is null\nfor future\nsubscriptions as it is yet to be started.
Time at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles\nor a custom value depending on the site configuration\n.
If true\n, ignores the hierarchy relationship\nand uses customer as payment and invoice owner.
When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the paused\nstate, it is the date/time when the subscription was paused.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
This is the date/time at which the most recent cancellation schedule for the subscription was created in Chargebee. Applicable only for cancelled\nsubscriptions or subscriptions that are scheduled for cancellation.
The Net D\nvalue explicitly set for this subscription. Net D is the number of days from invoice.date until payment for the invoice is due. When an invoice is raised, and this value is unavailable, the net_term_days defined at the customer level\nis considered.
Note: Present only when the subscription has been transferred between business entities.
Represents the id of the active version of the subscription resource.
Tip\nIf the id and active_id of a subscription resource are the same, this indicates that you are working with the active version of that subscription resource.
Total number of invoices that are due for payment against the subscription.\nNote:\nNot supported if consolidated invoicing\nis enabled, or when the subscription is for the customer who is in hierarchy\n, and the parent of this customer owns and pays for the invoices of the subscription. It is also worth noting that the consolidated invoice amount is not included in the calculation of due_invoices_count\n.
Total invoice due amount for this subscription. The value depends on the type of currency\n.\nNote:\nNot supported if consolidated invoicing\nis enabled, or when the subscription is for the customer who is in hierarchy\n, and the parent of this customer owns and pays for the invoices of the subscription. It is also worth noting that the consolidated invoice amount is not included in the calculation of total_dues\n.
Indicates that the subscription has been deleted when the value is true.\nYou can retrieve a deleted subscription using the list operation\n.
The period of time by which the first term of the subscription is extended free of charge. The value is expressed in the time unit specified by free_period_unit. For example, 3 with free_period_unit = month means 3 free months are added to the first term.
The time unit for free_period.
Charge based on week(s)
\n* month -Charge based on month(s)
\n* day -Charge based on day(s)
\n* year -Charge based on year(s)
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "create_pending_invoices" : { "type" : "boolean", "deprecated" : false, "description" : "Indicates whether the invoices for this subscription are generated with a pending status. This attribute is set to true automatically when the subscription has item prices that belong to metered items.\nYou can also set this to true explicitly using the create/update subscription operations. This is useful in the following scenarios:
Set to false\nto override for this subscription, the site-level setting\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level\n.
Indicates whether the subscription should be decommissioned when it is canceled. If set to true all subscription operations will be disabled except deletion.
Note: Decommission operation is irreversible. Once set to true it cannot be updated to false and thus subscription will remain decommissioned permanently.
The type of item. There must be one and only one item of type plan\nin this list.
Plan
\n* charge -Charge
\n* addon -Addon
", "enum" : [ "plan", "addon", "charge" ], "example" : null }, "quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The quantity of the item purchased\n", "minimum" : 1, "example" : null }, "quantity_in_decimal" : { "type" : "string", "deprecated" : false, "description" : "The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started)\nis enabled.\n", "maxLength" : 33, "example" : null }, "unit_price" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The price/per unit price of the item. When not provided, the value set\nfor the item price is used. This is only applicable when the pricing_model\nof the item price is flat_fee\nor per_unit.\nAlso, it is only allowed when price overriding\nis enabled for the site. The value depends on the type of currency. If changes_scheduled_at\nis in the past and a unit_price\nis not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
The total amount for the item as determined from unit_price\n, free_quantity\n, quantity\nand item_tiers\nas applicable. The value depends on the type of currency\n.
The date or time at when the next billing for the item is scheduled to occur. This typically occurs immediately after current_term_end.
Note\nApplicable only when multi-frequency billing is enabled.
Private Beta\nMulti-frequency billing is in private beta. Please reach out to the Chargebee support to enable this feature.
Specifies the length of each billing cycle for this subscription item, expressed in the unit defined by subscription_items.billing_period_unit.
Returned only if
\nMulti-Frequency Billing is enabled.Specifies the unit used to measure the subscription_items.billing_period.
Returned only if
\nMulti-Frequency Billing is enabled.A period of 1 calendar year.
\n* week -A period of 7 days.
\n* day -A period of 24 hours.
\n* month -A period of 1 calendar month.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "free_quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The free_quantity\nof the plan-item as specified\nfor the item price.
The free_quantity_in_decimal\nas set for the item price. Returned for quantity-based item prices when multi-decimal pricing\nis enabled.
When charge_on_option\noption is set to on_event\n, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
when a contract term is terminated\n.
\n* subscription_trial_start -the time when the trial period of the subscription begins.
\n* subscription_activation -the moment a subscription enters an active\nor non-renewing\nstate. Also includes reactivations of canceled subscriptions.
same as subscription activation, but also includes the case when the plan-item of the subscription is changed.
\n* subscription_creation -the time of creation of the subscription.
", "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ], "example" : null }, "charge_once" : { "type" : "boolean", "deprecated" : false, "description" : "Indicates if the charge-item is to be charged only once or each time the charge_on_event\noccurs. This parameter only applies to charge-items.
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
\n* immediately -The item is charged immediately on being added to the subscription.
\n* on_event -The item is charged at the occurrence of the event specified as charge_on_event\n.
Specifies how to manage charges or credits for the addon during a subscription update.
\nYou can't modify this parameter's value within the current term. Moreover, it is removed from the subscription attributes when the next term starts.
\nSee also:\nsubscription_items[proration_type]\nparameter for Update a subscription API\n.
Don't apply any charges or credits for the addon.
\n* full_term -Charge the full price of the addon or give the full credit. Don't apply any proration.
\n* partial_term -Prorate the charges or credits from the time of the change till the end of the current term.
", "enum" : [ "full_term", "partial_term", "none" ], "example" : null }, "usage_accumulation_reset_frequency" : { "type" : "string", "deprecated" : false, "description" : "Specifies the frequency at which the usage counter needs to be reset.\n\\* subscription_billing_frequency -\n\nAccumulates usage until the subscription's billing frequency ends.\n\\* never -\n\nAccumulates usage without ever resetting it.\n", "enum" : [ "never", "subscription_billing_frequency" ], "example" : null } }, "required" : [ "item_price_id", "item_type" ], "example" : null }, "example" : null }, "item_tiers" : { "type" : "array", "deprecated" : false, "description" : "The pricing details of subscription_items\nwhich have pricing_model\nas\ntiered\n, volume\nor stairstep\n.
The per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nThe total cost for the item price when the pricing_model\nis stairstep.\nThe value is in the minor unit of the currency.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the pricing_model is tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The index number of the subscription to which the item price is added. Provide a unique number between 0\nand 4\n(inclusive) for each subscription that is to be created.
The date till when the coupon can be applied. Applicable for limited_period\ncoupons\nonly.
The ISO 3166-2 state/province code\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code\nas AZ\n(not US-AZ\n). For Tamil Nadu (India), set as TN\n(not IN-TN\n). For British Columbia (Canada), set as BC\n(not CA-BC\n).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Maximum amount of excess payments that can be applied to any single invoice associated with this subscription. Set to -1 to auto-apply without limit, 0 to prevent auto-application, or any positive value to define the maximum amount that can be applied.
Maximum amount of refundable credits that can be applied to any single invoice associated with this subscription. Set to -1 to auto-apply without limit, 0 to prevent auto-application, or any positive value to define the maximum amount that can be applied.
Action to be taken when the contract term completes.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The sum of the totals\nof all the invoices raised as part of the contract term. For active\ncontract terms, this is a predicted value. The value depends on the type of currency.\nIf the subscription was imported\nwith the contract term, then this value includes the value passed for total_amount_raised\n.
It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for total_amount_raised_before_tax\nis included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.
The number of days before contract_end\n, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.
The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for active\ncontract terms.
List of discounts\ncurrently attached to the subscription.
\nNote
duration_type one_time are removed from the list after a single application to the subscription.duration_type limited_period are removed from the list once the specified period expires since their attachment to the subscription.The name of the discount as it should appear on customer-facing pages and documents such as invoices\nand hosted pages.\nThis is auto-generated based on the type\n, amount\n, and currency_code\nof the discount. For example, it can be 10% off\nor 10$ off\n.
The type of discount.\nPossible value are:
\n* offer_quantity -A specified number of units of the item price are offered for free. The number of free units is specified in quantity.\nThe offer_quantity\noption is valid only when apply_on\nis set to each_specified_item\nand the pricing_model\nof the item price is per_unit\n.
The specified percentage will be given as discount.
\n* fixed_amount -The specified amount will be given as discount.
", "enum" : [ "fixed_amount", "percentage", "offer_quantity" ], "example" : null }, "percentage" : { "type" : "number", "format" : "double", "deprecated" : false, "description" : "The percentage of the original amount that should be deducted from it.\n", "maximum" : 100, "minimum" : 0.01, "example" : null }, "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The value of the discount. [The format of this value](/docs/api/currencies)\ndepends on the kind of currency.\n", "minimum" : 0, "example" : null }, "quantity" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Specifies the number of free units provided for the item, without affecting the total quantity sold. This parameter is applicable only when discount.type\nis offer_quantity.
The currency code (ISO 4217 format\n) of the discount. This is only applicable when discount.type\nis fixed_amount\n.
Specifies the time duration for which this discount is attached to the subscription.
\n\n* limited_period -The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period\nand period_unit\n.
The discount is attached to the subscription and applied on the invoices till it is explicitly removed\n.
\n* one_time -The discount stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "enum" : [ "one_time", "forever", "limited_period" ], "example" : null }, "period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The duration of time for which the discount is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period.
The unit of time for period.\nApplicable only when duration_type\nis limited_period.
A period of 7 days.
\n* year -A period of 1 calendar year.
\n* day -A period of 24 hours.
\n* month -A period of 1 calendar month.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "included_in_mrr" : { "type" : "boolean", "deprecated" : false, "description" : "The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type\nis one_time\nand when the feature is enabled\nin Chargebee. Also, If the site-level setting\nis to exclude one-time discounts from MRR calculations, this value is always returned false.
The amount on the invoice to which the discount is applied.
\n\n* invoice_amount -The discount is applied to the invoice sub_total\n.
The discount is applied to the invoice.line_item.amount\nthat corresponds to the item price specified by item_price_id\n.
The id of the item price\nin the subscription to which the discount is to be applied. Relevant only when apply_on\n= specific_item_price.
Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for limited_period\nduration type discount.
Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
The index number of the subscription to which the item price is added. Provide a unique number between 0\nand 4\n(inclusive) for each subscription that is to be created.
The subscription entitlement object represents the entitlement a subscription holds for a feature. A subscription can have several subscription entitlements, each tied to a specific feature.
When an entitlement override with entity_type set to subscription is set for a subscription related to a feature, the subscription entitlement takes on the value of that override.
If there is no entitlement override for the subscription and feature, the subscription entitlement is based on the entitlements linked to the item prices within the subscription items. If an item price lacks an entitlement record for a particular feature, we consider the entitlement (when available) of its parent item.
The method used to derive the subscription entitlement from these entitlements follows specific rules determined by the feature type. We outline and provide examples of these rules in the sections below:
Consider a feature of type switch. Consider also a subscription whose subscription items correspond to item prices (or items) that have entitlements to the feature. Looking at these entitlements, we first determine the entitlement value held by each subscription item for this feature.
If the entitlement value for the feature held by any of the subscription items is true, then the subscription entitlement value is also set to true. Otherwise, the subscription entitlement value is set to false.
Consider the following feature record:
id | type | description |
|---|---|---|
xero-integration | switch | An integration with the Xero accounting software. |
Consider the following entitlement records for the xero-integration feature:
entity_id | entity_type | value |
|---|---|---|
starter | plan | true |
starter-monthly-usd | plan_price | false |
plus | addon | true |
Consider that a subscription with ID AzZjAiTl1btqS2lEj has the following subscription_items[] records:
| Index | item_price_id | quantity |
|---|---|---|
0 | starter-monthly-usd | 1 |
1 | plus-monthly-usd | 1 |
2 | installation-usd | 2 |
Chargebee Billing now determines the entitlement held by each subscription item based on the entitlements defined in Table 2. This is shown in Table 4. For clarity, we've omitted the quantity column because it doesn't affect features with type switch.
| Index | item_price_id | Entitlement value (determined from Table 2) |
|---|---|---|
0 | starter-monthly-usd | false (Matches the value of the plan price.) |
1 | plus-monthly-usd | true (Inherited from the addon plus, as no entitlement is defined for this addon price.) |
2 | installation-usd | None (No entitlement defined for the charge item.) |
In this scenario, the final entitlement (subscription_entitlement.value) for the xero-integration feature is set to true because at least one subscription-item entitlement value is true.
Suppose there's an entitlement override added to the subscription for the feature, as shown below:
entity_id | entity_type | feature_id | value |
|---|---|---|---|
AzZjAiTl1btqS2lEj | subscription | xero-integration | false |
Given this override, the subscription's final entitlement value for the xero-integration feature is set to false.
Consider a feature of type quantity. Consider also a subscription whose subscription items correspond to item prices (or items) that have entitlements to the feature. Looking at these entitlements, we first determine the entitlement value held by each subscription item for this feature.
If the entitlement value for the feature held by any of the subscription items is unlimited, then the subscription entitlement value is also unlimited. Otherwise, the subscription entitlement value is the sum of all the entitlement values of the subscription items.
Consider the following feature record:
id | type | description |
|---|---|---|
user_licenses | quantity | The number of user licenses provided. |
Suppose that the feature has feature.levels[] records as follows:
level | value | is_unlimited |
|---|---|---|
0 | 5 | false |
1 | 10 | false |
2 | 20 | false |
3 | Not set. | true |
Consider the following entitlement records for the user_licenses feature:
entity_id | entity_type | value |
|---|---|---|
starter | plan | 10 |
starter-monthly-usd | plan_price | unlimited |
plus | addon | 5 |
one-time | charge | 5 |
Consider that a subscription with ID AzZjAiTl1btqS2lEj has the following subscription_items[] records:
| Index | item_price_id | quantity |
|---|---|---|
0 | starter-monthly-usd | 5 |
1 | plus-monthly-usd | 10 |
2 | one-time-usd | 1 |
Chargebee Billing now determines the entitlement held by each subscription item based on the entitlements defined in Table 8. This is shown in Table 10.
| Index | item_price_id | quantity | Entitlement value (determined from Table 8) | Entitlement value subtotal (Entitlement value × quantity) |
|---|---|---|---|---|
0 | starter-monthly-usd | 5 | unlimited (Matches the value of the plan price.) | unlimited (unlimited x 5) |
1 | plus-monthly-usd | 10 | 5 (Inherited from the addon plus, as no entitlement is defined for this addon price.) | 50 (5 x 10) |
2 | one-time-usd | 1 | 5 (Inherited from the charge one-time.) | 5 (5 x 1) |
In this scenario, the final entitlement value (subscription_entitlement.value) for the user_licenses feature is the total entitlement value from the last column in Table 10, which amounts to (unlimited + 50 + 5) = unlimited.
Suppose there's an entitlement override added to the subscription for the feature, as shown below:
entity_id | entity_type | feature_id | value |
|---|---|---|---|
AzZjAiTl1btqS2lEj | subscription | user_licenses | 20 |
Given this override, the subscription's final entitlement value for the user_licenses feature is set to 20.
Consider a feature of type range. Consider also a subscription whose subscription items correspond to item prices (or items) that have entitlements to the feature. Looking at these entitlements, we first determine the entitlement value held by each subscription item for this feature.
If the entitlement value for the feature held by any of the subscription items is unlimited, then the subscription entitlement value is also unlimited. Otherwise, one of two scenarios are possible:
If feature.levels[1].is_unlimited is true, the subscription entitlement value equals the sum of all entitlement values of the subscription items.
If feature.levels[1].is_unlimited is false, the subscription entitlement value equals the sum of all entitlement values of the subscription items without exceeding the maximum value of feature.level[1].value.
Consider the following feature record:
id | type | description |
|---|---|---|
api_rate_limit | range | The maximum number of API requests allowed per minute. |
Suppose that the feature has feature.levels[] records as follows:
level | value | is_unlimited |
|---|---|---|
0 | 100 | false |
1 | 1000 | false |
Consider the following entitlement records for the api_rate_limit feature:
entity_id | entity_type | value |
|---|---|---|
premium | plan | 450 |
premium-monthly-usd | plan_price | 400 |
plus | addon | 150 |
Consider that a subscription with ID AzZjAiTl1btqS2lEj has the following subscription_items[] records:
| Index | item_price_id | quantity |
|---|---|---|
0 | premium-monthly-usd | 2 |
1 | plus-monthly-usd | 2 |
Chargebee Billing now determines the entitlement held by each subscription item based on the entitlements defined in Table 14. This is shown in Table 16.
subscription_items[] index | item_price_id | quantity | Entitlement value (determined from Table 14) | Entitlement value subtotal (Entitlement value x quantity) |
|---|---|---|---|---|
0 | premium-monthly-usd | 2 | 400 (Matches the value of the plan price.) | 800 (400 x 2) |
1 | plus-monthly-usd | 2 | 150 (Inherited from the addon plus, as no entitlement is defined for this addon price.) | 300 (150 x 2) |
feature.levels[1].is_unlimited is falseIn this scenario, the final entitlement value (subscription_entitlement.value) for the api_rate_limit feature is the total entitlement value from the last column in Table 16, capped at feature.levels[1].value. The total entitlement value is 800 + 300 = 1100. However, feature.levels[1].value is 1000, which is less than 1100. Therefore, the final entitlement is 1000.
feature.levels[1].is_unlimited is trueIn this scenario, feature.levels[1].value is disregarded, and the final entitlement value is not capped. In other words, the final entitlement value is 1100.
Consider a feature of type custom. Consider also a subscription whose subscription items correspond to item prices (or items) that have entitlements to the feature.
Looking at these entitlements, we first determine the entitlement value held by each subscription item for this feature. The subscription entitlement value is then set to the highest of these identified values.
Consider the following feature record:
id | type | description |
|---|---|---|
support | custom | The form of after-sales support provided to the customer. |
Suppose that the feature has feature.levels[] records as follows:
level | value |
|---|---|
0 | email |
1 | chat |
2 | call |
Consider the following entitlement records for the support feature:
entity_id | entity_type | value |
|---|---|---|
starter | plan | chat |
starter-monthly-usd | plan_price | email |
plus | addon | call |
Consider that a subscription with ID AzZjAiTl1btqS2lEj has the following subscription_items[] records:
| Index | item_price_id | quantity |
|---|---|---|
0 | starter-monthly-usd | 2 |
1 | plus-monthly-usd | 2 |
Chargebee Billing now determines the entitlement held by each subscription item based on the entitlements defined in Table 19. This is shown in Table 21. For clarity, we've omitted the quantity column because it doesn't affect features with type custom.
| Index | item_price_id | Subscription-Item Entitlement Value (determined from Table ) |
|---|---|---|
0 | starter-monthly-usd | email (Matches the value of the plan price.) |
1 | plus-monthly-usd | call (Inherited from the addon plus, as no entitlement is defined for this addon price.) |
In this scenario, the final entitlement for the support feature is the highest of all the subscription-item entitlement values, which in this case is call.
Suppose there's an entitlement override added to the subscription for the feature, as shown below:
entity_id | entity_type | feature_id | value | expires_at |
|---|---|---|---|---|
AzZjAiTl1btqS2lEj | subscription | support | chat | 1695884985 (7 days from now, assuming today is 2023-09-21.) |
Given this override, the subscription's final entitlement value for the support feature will be chat until 2023-09-21 and call thereafter.
When an entitlement override with entity_type set to plan_price, addon_price, or charge is set for a subscription, the override affects the entitlement value used for that specific entity when calculating subscription-item entitlements. If an entitlement override exists for a plan price, addon price, or charge entity, its value is used instead of the regular entitlement value for that entity.
The method used to derive the subscription entitlement from these overridden values follows the same rules determined by the feature type as described in the sections above. We outline and provide examples of these rules in the sections below:
When calculating subscription-item entitlements for a feature of type switch, if an entitlement override exists for a plan price, addon price, or charge entity, the override's value is used instead of the regular entitlement value for that entity. The final subscription entitlement value is then determined using the same logic as described in the Switch feature section: if the entitlement value for the feature held by any of the subscription items is true, then the subscription entitlement value is also set to true. Otherwise, the subscription entitlement value is set to false.
Consider the following feature record:
id | type | description |
|---|---|---|
xero-integration | switch | An integration with the Xero accounting software. |
Consider the following entitlement records for the xero-integration feature:
entity_id | entity_type | value |
|---|---|---|
starter | plan | true |
starter-monthly-usd | plan_price | false |
plus | addon | false |
Consider that a subscription with ID AzZjAiTl1btqS2lEj has the following subscription_items[] records:
| Index | item_price_id | quantity |
|---|---|---|
0 | starter-monthly-usd | 1 |
1 | plus-monthly-usd | 1 |
Suppose there's an entitlement override added to the subscription for the plus-monthly-usd addon price, as shown below:
entity_id | entity_type | feature_id | value |
|---|---|---|---|
plus-monthly-usd | addon_price | xero-integration | true |
Chargebee Billing now determines the entitlement held by each subscription item based on the entitlements defined in Table 24, but uses the override value from Table 26 for the plus-monthly-usd addon price. This is shown in Table 27. For clarity, we've omitted the quantity column because it doesn't affect features with type switch.
| Index | item_price_id | Entitlement value |
|---|---|---|
0 | starter-monthly-usd | false (Matches the value of the plan price entitlement.) |
1 | plus-monthly-usd | true (Uses the override value from Table 26 instead of inheriting false from the addon plus.) |
In this scenario, the final entitlement for the xero-integration feature is set to true because at least one subscription-item entitlement value is true (the overridden value for plus-monthly-usd).
When calculating subscription-item entitlements for a feature of type quantity, if an entitlement override exists for a plan price, addon price, or charge entity, the override's value is used instead of the regular entitlement value for that entity. The final subscription entitlement value is then determined using the same logic as described in the Quantity feature section: if the entitlement value for the feature held by any of the subscription items is unlimited, then the subscription entitlement value is also unlimited. Otherwise, the subscription entitlement value is the sum of all the entitlement values of the subscription items.
Consider the following feature record:
id | type | description |
|---|---|---|
user_licenses | quantity | The number of user licenses provided. |
Suppose that the feature has feature.levels[] records as follows:
level | value | is_unlimited |
|---|---|---|
0 | 5 | false |
1 | 10 | false |
2 | 20 | false |
Consider the following entitlement records for the user_licenses feature:
entity_id | entity_type | value |
|---|---|---|
starter | plan | 10 |
starter-monthly-usd | plan_price | 5 |
plus | addon | 5 |
one-time | charge | 5 |
Consider that a subscription with ID AzZjAiTl1btqS2lEj has the following subscription_items[] records:
| Index | item_price_id | quantity |
|---|---|---|
0 | starter-monthly-usd | 2 |
1 | plus-monthly-usd | 3 |
2 | one-time-usd | 1 |
Suppose there are entitlement override records added to the subscription for the plan price and charge, as shown below:
entity_id | entity_type | feature_id | value |
|---|---|---|---|
starter-monthly-usd | plan_price | user_licenses | 10 |
one-time | charge | user_licenses | 10 |
Chargebee Billing now determines the entitlement held by each subscription item based on the entitlements defined in Table 30, but uses the override values from Table 32 for the starter-monthly-usd plan price and one-time charge. This is shown in Table 33.
| Index | item_price_id | quantity | Entitlement value | Entitlement value subtotal (Entitlement value × quantity) |
|---|---|---|---|---|
0 | starter-monthly-usd | 2 | 10 (Uses the override value from Table 32 instead of the plan price entitlement value of 5.) | 20 (10 x 2) |
1 | plus-monthly-usd | 3 | 5 (Inherited from the addon plus, as no entitlement is defined for this addon price and no override exists.) | 15 (5 x 3) |
2 | one-time-usd | 1 | 10 (Uses the override value from Table 32 instead of the charge entitlement value of 5.) | 10 (10 x 1) |
In this scenario, the final entitlement value for the user_licenses feature is the total entitlement value from the last column in Table 33, which amounts to (20 + 15 + 10) = 45.
When calculating subscription-item entitlements for a feature of type range, if an entitlement override exists for a plan price, addon price, or charge entity, the override's value is used instead of the regular entitlement value for that entity. The final subscription entitlement value is then determined using the same logic as described in the Range feature section: if the entitlement value for the feature held by any of the subscription items is unlimited, then the subscription entitlement value is also unlimited. Otherwise, one of two scenarios are possible:
If feature.levels[1].is_unlimited is true, the subscription entitlement value equals the sum of all entitlement values of the subscription items.
If feature.levels[1].is_unlimited is false, the subscription entitlement value equals the sum of all entitlement values of the subscription items without exceeding the maximum value of feature.level[1].value.
Consider the following feature record:
id | type | description |
|---|---|---|
api_rate_limit | range | The maximum number of API requests allowed per minute. |
Suppose that the feature has feature.levels[] records as follows:
level | value | is_unlimited |
|---|---|---|
0 | 100 | false |
1 | 1000 | false |
Consider the following entitlement records for the api_rate_limit feature:
entity_id | entity_type | value |
|---|---|---|
premium | plan | 450 |
premium-monthly-usd | plan_price | 400 |
plus | addon | 150 |
Consider that a subscription with ID AzZjAiTl1btqS2lEj has the following subscription_items[] records:
| Index | item_price_id | quantity |
|---|---|---|
0 | premium-monthly-usd | 2 |
1 | plus-monthly-usd | 2 |
Suppose there's an entitlement override added to the subscription for the addon price, as shown below:
entity_id | entity_type | feature_id | value |
|---|---|---|---|
plus-monthly-usd | addon_price | api_rate_limit | 300 |
Chargebee Billing now determines the entitlement held by each subscription item based on the entitlements defined in Table 36, but uses the override value from Table 38 for the plus-monthly-usd addon price. This is shown in Table 39.
| Index | item_price_id | quantity | Entitlement value | Entitlement value subtotal (Entitlement value × quantity) |
|---|---|---|---|---|
0 | premium-monthly-usd | 2 | 400 (Matches the value of the plan price.) | 800 (400 x 2) |
1 | plus-monthly-usd | 2 | 300 (Uses the override value from Table 38 instead of inheriting 150 from the addon plus.) | 600 (300 x 2) |
feature.levels[1].is_unlimited is falseIn this scenario, the final entitlement value for the api_rate_limit feature is the total entitlement value from the last column in Table 39, capped at feature.levels[1].value. The total entitlement value is 800 + 600 = 1400. However, feature.levels[1].value is 1000, which is less than 1400. Therefore, the final entitlement is 1000.
feature.levels[1].is_unlimited is trueIn this scenario, feature.levels[1].value is disregarded, and the final entitlement value is not capped. In other words, the final entitlement value is 1400.
When calculating subscription-item entitlements for a feature of type custom, if an entitlement override exists for a plan price, addon price, or charge entity, the override's value is used instead of the regular entitlement value for that entity. The final subscription entitlement value is then determined using the same logic as described in the Custom feature section: the subscription entitlement value is set to the highest of the identified subscription-item entitlement values.
Consider the following feature record:
id | type | description |
|---|---|---|
support | custom | The form of after-sales support provided to the customer. |
Suppose that the feature has feature.levels[] records as follows:
level | value |
|---|---|
0 | email |
1 | chat |
2 | call |
Consider the following entitlement records for the support feature:
entity_id | entity_type | value |
|---|---|---|
starter | plan | chat |
starter-monthly-usd | plan_price | email |
plus | addon | email |
Consider that a subscription with ID AzZjAiTl1btqS2lEj has the following subscription_items[] records:
| Index | item_price_id | quantity |
|---|---|---|
0 | starter-monthly-usd | 2 |
1 | plus-monthly-usd | 2 |
Suppose there's an entitlement override added to the subscription for the addon price, as shown below:
entity_id | entity_type | feature_id | value |
|---|---|---|---|
plus-monthly-usd | addon_price | support | call |
Chargebee Billing now determines the entitlement held by each subscription item based on the entitlements defined in Table 42, but uses the override value from Table 44 for the plus-monthly-usd addon price. This is shown in Table 45. For clarity, we've omitted the quantity column because it doesn't affect features with type custom.
| Index | item_price_id | Subscription-Item Entitlement Value |
|---|---|---|
0 | starter-monthly-usd | email (Matches the value of the plan price.) |
1 | plus-monthly-usd | call (Uses the override value from Table 44 instead of inheriting email from the addon plus.) |
In this scenario, the final entitlement for the support feature is the highest of all the subscription-item entitlement values, which in this case is call (the overridden value for plus-monthly-usd).
The unit of measure\nfor the feature when its type\nis either quantity\nor range\n.
The display name of the final entitlement level that the subscription holds for the feature. It is derived based on the type\nof feature as follows: - When feature.type is range or quantity: the name is the space-separated concatenation of value and the pluralized form of feature_unit. For example, if value is 20 and feature_unit is user, then name becomes 20 users.
feature.type is custom: the name is the same as value.feature.type is switch: name is set to Available when value is true; it's set to Not Available when value is false.Indicates whether the entitlement held by the subscription for the feature is overridden via an entitlement_overrides\nrecord.
Indicates that components.is_enabled\nexists.
The component entitlements that constitute this subscription_entitlement.\nThe effective entitlement value\nand name\nare determined from these component entitlements.
When a subscription entitlement has been explicitly overridden, this object contains the details of said override. An entitlement_override\ncan be temporary\nsuch that it expires at some point in time and is no longer returned.
The level of entitlement that the subscription has towards the feature. The possible values depend on the value of feature.type\n:
When feature.type is custom: The value can be any one of levels[].value.
When feature.type is switch: This value is true.
When feature.type is quantity:
When levels[].is_unlimited is not true: The value can be any one of levels[].value.
When levels[].is_unlimited is true: The value can also be any one of levels[].value or it can be unlimited (case-insensitive), indicating unlimited entitlement.
When feature.type is range:
When levels[].is_unlimited is not true: The value can be any whole number between levels[0].value and levels[1].value (inclusive).
When levels[].is_unlimited is true: The value can be any whole number equal to or greater than levels[0].value or it can be unlimited (case-insensitive), indicating unlimited entitlement.
A case-sensitive name for the subscription entitlement override. If it was not provided while creating this subscription entitlement override, then it is derived based on the feature.type\nas follows:
feature.type is range or quantity: the name is the space-separated concatenation of value and the pluralized form of feature_unit. For example, if value is 20 and feature_unit is user, then name becomes 20 users.feature.type is custom: the name is the same as value.feature.type is switch: name is not applicable.Tax regulations in many countries allow taxes to be deducted by the buyer while making payments for products and services. The buyer then pays this tax to the taxation authority. The tax_withheld resource captures the details of such tax deductions.
Note:
linked_taxes_withheld sub-resource under invoices.linked_tax_withheld_refunds sub-resource under credit_notes.An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_.\nFor example, tax_wh_16BdDXSlbu4uV1Ee6\n.
A unique display name for the item price in the Chargebee UI. If external_name\nis not provided, this is also used in customer-facing pages and documents such as invoices\nand hosted pages\n.
The status of the item price.
\n* archived -The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.
\n* active -The item price can be used in subscriptions.
\n* deleted -Indicates that the item price has been deleted. The id\nand name\ncan be reused.
The name of the item price used in customer-facing pages and documents. These include invoices\nand hosted pages.\nIf not provided, then name\nis used
The pricing scheme for this item price. If subscriptions, invoices or differential prices exist for this item price, pricing_model cannot be changed.
There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
\n* per_unit -A fixed price per unit quantity.
\n* flat_fee -A fixed price that is not quantity-based.
\n* volume -The per unit price is based on the tier that the total quantity falls in.
\n* stairstep -A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
", "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ], "example" : null }, "price" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The cost of the item price when the pricing model is flat_fee.\nWhen the pricing model is per_unit\n, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the minor unit of the currency\n.
The price of the item when the pricing_model is flat_fee.\nWhen the pricing model is per_unit\n, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when multi-decimal pricing\nis enabled.
type is plan: The billing period of the plan in period_units. For example, create a 6 month plan by providing period as 6 and period_unit as month.type is addon: The period of the addon in period_units. For example, create an addon with a 2 month period by providing period as 2 and period_unit as month. The period of an addon is the duration for which its price applies. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.If subscriptions or invoices exist for this item price, period\ncannot be changed. The period\nis mandatory when the item type\nis plan\nor addon
The unit of time for period.\nIf subscriptions or invoices exist for this item price, period_unit\ncannot be changed. The period_unit\nis mandatory when the item type\nis plan\nor addon
A period of 1 calendar month.
\n* day -A period of 24 hours.
\n* week -A period of 7 days.
\n* year -A period of 1 calendar year.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "trial_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The trial period of the plan in trial_period_unit\ns. You can also set trial periods for addons\n; contact Support\nto enable that feature.
The unit of time for trial_period\n.
A period of 1 calendar month.
\n* day -A period of 24 hours.
", "enum" : [ "day", "month" ], "example" : null }, "trial_end_action" : { "type" : "string", "deprecated" : false, "description" : "Applicable only when End-of-trial Action\nhas been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the item.type\nis plan\nand a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the subscription-level\n.
The subscription cancels.
\n* activate_subscription -The subscription activates and charges are raised for non-metered items.
\n* site_default -The action configured for the site\nat the time when the trial ends, takes effect.
", "enum" : [ "site_default", "activate_subscription", "cancel_subscription" ], "example" : null }, "shipping_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Defines the shipping frequency. Example: to bill customer every 2 weeks, provide \"2\" here.\n", "minimum" : 1, "example" : null }, "shipping_period_unit" : { "type" : "string", "deprecated" : false, "description" : "Defines the shipping frequency in association with shipping period.\n\\* year -\n\nA period of 1 calendar year.\n\\* day -\n\nA period of 24 hours.\n\\* week -\n\nA period of 7 days.\n\\* month -\n\nA period of 1 calendar month.\n", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "billing_cycles" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The default number of billing cycles a subscription to the plan must run. Can be overridden for a subscription.\nAddons can also have billing cycles. However, you must contact Support to enable that. Also, for addons, you can override this while attaching it to a plan. However, if you provide the value while applying the addon to a subscription, then that value takes still higher precedence.\nIf subscriptions, invoices or differential prices\nexist for this item price, billing_cycles\ncannot be changed.
Free quantity the subscriptions of this plan item_price will have. Only the quantity exceeding this value will be charged in the subscription.
Note:
free_quantity is currently supported only for plan item_price.free_quantity\nis not supported for the Usage-Based Billing\n(UBB). All included or free quantities should be configured exclusively through entitlements\n.If enabled_for_checkout\n, then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.
The item is included in MRR calculations for your site. This attribute is only applicable for items of type = charge\nand when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude charge-items from MRR calculations, this value is always returned false\n.
Indicates which addon-items and charge-items can be applied to the item. Only meant for plan-items. Other details of attaching items such as whether to attach as a mandatory item or to attach on a certain event, can be specified using the Create\nor Update an attached item\nAPI.
\n* all -all addon-items and charge-items are applicable to this plan-item.
\n* restricted -only the addon-items or charge-items provided in applicable_items\ncan be applied to this plan-item.
Used exclusively with the following accounting integrations
\n: . For example:Location: Singapore.::...: : .... For example: Services : Plan.Used exclusively with the following accounting integrations
\n: .... For example, Region: South::.... For example: Location: North America: Canada: : .... For example: NA:US:CAUsed exclusively with the following accounting integrations
\n: : .... For example: Production: Assembly.Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
The payment method of this transaction
\n* naver_pay -Payments made via Naver Pay.
\n\n* unionpay -Unionpay
\n* 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* 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* card -Card
\n* ideal -IDEAL
\n* chargeback -Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.
Automated Bank Transfer
\n\n* google_pay -Google Pay
\n* netbanking_emandates -netbanking_emandates
\n* pay_to -PayTo
\n\n* pay_by_bank -Pay By Bank
\n* dotpay -Dotpay
\n* alipay -Payments made via Alipay.
\n\n* sofort -Sofort
\n* swish -Payments made via Swish
\n\n* grab_pay -Payments made via GrabPay
\n\n* pix -Pix
\n\n* giropay -giropay
\n* pay_co -Payments made via PayCo
\n\n* revolut_pay -Payments made via Revolut Pay.
\n\n* cash -Cash
\n* after_pay -Payments made via Afterpay
\n", "enum" : [ "card", "cash", "check", "chargeback", "bank_transfer", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "other", "upi", "netbanking_emandates", "custom", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna" ], "example" : null }, "reference_number" : { "type" : "string", "deprecated" : false, "description" : "The reference number for this transaction. For example, the check number when payment_method\n= check\n.
Type of the transaction.
\n* authorization -The transaction represents an authorization for capturing the amount\nfrom the customer's payment_source\n.
The transaction represents capture of amount\nfrom the customer's payment_source\n.
The transaction represents a refund of amount\nto the customer's payment_source\n.
Indicates a reversal transaction.
", "enum" : [ "authorization", "payment", "refund", "payment_reversal" ], "example" : null }, "date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates when this transaction occurred.\n", "example" : null }, "settled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates the time at which the final status of the transaction has been marked.\n", "example" : null }, "exchange_rate" : { "type" : "number", "format" : "decimal", "deprecated" : false, "description" : "Exchange rate used for base currency conversion\n", "maximum" : 1000000000, "minimum" : 0.0000000010, "example" : null }, "currency_code" : { "type" : "string", "deprecated" : false, "description" : "The currency code (ISO 4217 format) for the transaction.\n", "maxLength" : 3, "example" : null }, "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Amount for this transaction.\n", "minimum" : 0, "example" : null }, "id_at_gateway" : { "type" : "string", "deprecated" : false, "description" : "The id with which this transaction is referred in gateway.\n", "maxLength" : 100, "example" : null }, "status" : { "type" : "string", "deprecated" : false, "description" : "The status of this transaction.
\n* in_progress -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.
\n* timeout -Transaction failed because of Gateway not accepting the connection.
\n* success -The transaction is successful.
\n* voided -The transaction got voided or authorization expired at gateway.
\n* needs_attention -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.
\n* failure -Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure
", "enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ], "example" : null }, "fraud_flag" : { "type" : "string", "deprecated" : false, "description" : "Indicates whether or not the transaction has been [identified as fraudulent](https://www.chargebee.com/docs/payments/2.0/fraud-management/chargebee-fraud-management).\n\\* suspicious -\n\nThe transaction has been identified as potentially fraudulent by the gateway\n\\* safe -\n\nThe transaction has been marked as safe\n\\* fraudulent -\n\nThe transaction has been marked as fraudulent\n", "enum" : [ "safe", "suspicious", "fraudulent" ], "example" : null }, "initiator_type" : { "type" : "string", "deprecated" : false, "description" : "Marker for on-session payments (3DS). null indicates 'merchant'.\n\\* merchant -\n\nPayment initiated on stored payment method by the merchant\n\\* customer -\n\nCustomer initiated 3DS payment\n", "enum" : [ "customer", "merchant" ], "example" : null }, "three_d_secure" : { "type" : "boolean", "deprecated" : false, "description" : "Indicates whether this transaction has gone through 3DS. Applicable only for 'on-session' payments \\& verifications.If 3DS is not enforced by the gateway/bank or if the customers' card is not enrolled, this will be false.\n", "example" : null }, "authorization_reason" : { "type" : "string", "deprecated" : false, "description" : "Type of authorization transaction.
\n* scheduled_capture -The transaction was authorized in advance for capture at a later time by a scheduled system job. The capture may succeed or fail, and its outcome is recorded as a linked transaction under linked_payments\n.
The transaction has been created for payment method verification.
\n* blocking_funds -The transaction has been created to block the funds from payment method.
", "enum" : [ "blocking_funds", "verification", "scheduled_capture" ], "example" : null }, "error_code" : { "type" : "string", "deprecated" : false, "description" : "Error code received from the payment gateway on failure.\n", "maxLength" : 100, "example" : null }, "error_text" : { "type" : "string", "deprecated" : false, "description" : "Error message received from the payment gateway on failure.\n", "maxLength" : 65000, "example" : null }, "voided_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp indicating when the payment was voided or authorization expired at gateway.\n", "example" : null }, "resource_version" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
This is the part of the amount\nwhich has not been invoiced yet and is therefore added to excess_payments\nfor the customer. Applicable only for a transaction of type\n= payment\n.
This is the id\nof the offline transaction that is being refunded or reversed. Applicable only for transaction of type\n= refund\nor payment_reversal\n.
This is the id\nof the transaction (always of type\n= payment\n) being refunded. Applicable only for transaction of type\n= refund\n.
This is the id\nof the transaction (always of type\n= authorization\n) which authorizes the payment being captured. Applicable only for transaction of type\n= payment\n.
This is the part of the authorized amount\nthat is yet to be captured. The payment capture is recorded as a transaction of of type\n= payment.\nApplicable only for a transaction of type\n= authorization\n.
The unique ID of the business entity\nof this transaction.\nThis is always the same as the business entity of the customer.
Current status of this invoice.
\n* pending -The invoice is yet to be closed (sent for payment collection). An invoice is generated with this status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.\nThe invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.
Indicates a voided invoice.
\n* payment_due -Indicates the payment is not yet collected and is being retried as per retry settings.
\n* paid -Indicates a paid invoice.
\n* posted -Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
\n* not_paid -Indicates the payment is not made and all attempts to collect is failed.
", "enum" : [ "paid", "posted", "payment_due", "not_paid", "voided", "pending" ], "example" : null } }, "required" : [ "applied_amount", "applied_at", "invoice_id", "invoice_status" ], "example" : null }, "example" : null }, "linked_credit_notes" : { "type" : "array", "deprecated" : false, "description" : "Applicable only for 'Refund' transactions. The list of Credit Notes this 'refund' transaction is associated with.\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "cn_id" : { "type" : "string", "deprecated" : false, "description" : "Identifier for the credit-notes.\n", "maxLength" : 50, "example" : null }, "applied_amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "The transaction amount applied to this invoice\n", "minimum" : 0, "example" : null }, "applied_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp at which the transaction is applied.\n", "example" : null }, "cn_reason_code" : { "type" : "string", "deprecated" : false, "description" : "Credit note reason code. Deprecated use the cn_create_reason_code parameter instead\n\\* service_unsatisfactory -\n\nService Unsatisfactory\n\\* other -\n\nCan be set when none of the above reason codes are applicable\n\\* subscription_cancellation -\n\nThis reason will be set automatically for Credit Notes created during cancel subscription operation\n\\* fraudulent -\n\nFRAUDULENT\n\\* order_change -\n\nOrder Change\n\\* subscription_pause -\n\nThis reason will be automatically set to credit notes created during pause/resume subscription operation.\n\\* write_off -\n\nThis reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)\noperation.\n\\* subscription_change -\n\nThis reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\nis enabled\n\\* chargeback -\n\nCan be set when you are recording your customer Chargebacks\n\\* waiver -\n\nWaiver\n\\* order_cancellation -\n\nOrder Cancellation\n\\* product_unsatisfactory -\n\nProduct Unsatisfactory\n", "enum" : [ "write_off", "subscription_change", "subscription_cancellation", "subscription_pause", "chargeback", "product_unsatisfactory", "service_unsatisfactory", "order_change", "order_cancellation", "waiver", "other", "fraudulent" ], "example" : null }, "cn_create_reason_code" : { "type" : "string", "deprecated" : false, "description" : "Credit note reason code\n", "maxLength" : 100, "example" : null }, "cn_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The date this credit note is created.\n", "example" : null }, "cn_total" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "Total amount of the credit note\n", "minimum" : 0, "example" : null }, "cn_status" : { "type" : "string", "deprecated" : false, "description" : "The status of this Credit Note.\n\\* voided -\n\nWhen the Credit Note has been cancelled.\n\\* refund_due -\n\nWhen the credits are yet to be used, or have been partially used.\n\\* refunded -\n\nWhen the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n\\* adjusted -\n\nWhen the Credit Note has been adjusted against an invoice.\n", "enum" : [ "adjusted", "refunded", "refund_due", "voided" ], "example" : null }, "cn_reference_invoice_id" : { "type" : "string", "deprecated" : false, "description" : "The invoice number. Acts as a identifier for invoice and typically generated sequentially.\n", "maxLength" : 50, "example" : null } }, "required" : [ "applied_amount", "applied_at", "cn_id", "cn_status" ], "example" : null }, "example" : null }, "linked_refunds" : { "type" : "array", "deprecated" : false, "description" : "Applicable only for Payment transactions. It only returns values when the transaction is not associated with an invoice, and that there is a refund for the transaction.\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "txn_id" : { "type" : "string", "deprecated" : false, "description" : "Uniquely identifies the transaction.\n", "maxLength" : 40, "example" : null }, "txn_status" : { "type" : "string", "deprecated" : false, "description" : "The status of this transaction.
\n* needs_attention -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
The transaction got voided or authorization expired at gateway.
\n* late_failure -Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.
\n* timeout -Transaction failed because of Gateway not accepting the connection.
\n* success -The transaction is successful.
\n* failure -Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure
\n* in_progress -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.
", "enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ], "example" : null }, "txn_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates when this refund occured.\n", "example" : null }, "txn_amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Amount of this refund transaction.\n", "minimum" : 0, "example" : null } }, "required" : [ "txn_amount", "txn_date", "txn_id", "txn_status" ], "example" : null }, "example" : null }, "linked_payments" : { "type" : "array", "deprecated" : false, "description" : "The list of payments captured for this authorization transaction.\n", "items" : { "type" : "object", "deprecated" : false, "properties" : { "id" : { "type" : "string", "deprecated" : false, "description" : "Uniquely identifies the transaction.\n", "maxLength" : 40, "example" : null }, "status" : { "type" : "string", "deprecated" : false, "description" : "The status of this transaction.
\n* needs_attention -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
The transaction is successful.
\n* voided -The transaction got voided or authorization expired at gateway.
\n* in_progress -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.
\n* failure -Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure
\n* late_failure -Indicates that a successful payment transaction has failed now due to a late failure notification from the payment gateway, typically caused by issues like insufficient funds or a closed bank account.
\n* timeout -Transaction failed because of Gateway not accepting the connection.
", "enum" : [ "in_progress", "success", "voided", "failure", "timeout", "needs_attention", "late_failure" ], "example" : null }, "amount" : { "type" : "integer", "format" : "int64", "deprecated" : false, "description" : "Amount for this transaction.\n", "minimum" : 0, "example" : null }, "date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates when this transaction occurred.\n", "example" : null } }, "required" : [ "id" ], "example" : null }, "example" : null }, "error_detail" : { "type" : "object", "deprecated" : false, "description" : "Comprehensive information regarding the error experienced during an unsuccessful or declined transaction. Learn more about \\[gateway error references\\](/docs/api/v2/pcv-1/gateway_error_references)\n", "properties" : { "request_id" : { "type" : "string", "deprecated" : false, "description" : "This is a unique identifier assigned by the payment gateway. It is used to track the request at the payment gateway\n", "maxLength" : 100, "example" : null }, "error_category" : { "type" : "string", "deprecated" : false, "description" : "This parameter categorizes the type of error that occurred for the request. It helps in understanding whether the error is due to API error, validation, processing, network issues, and more\n", "maxLength" : 100, "example" : null }, "error_code" : { "type" : "string", "deprecated" : false, "description" : "A gateway-specific code that corresponds to the particular error encountered for the request. This code can be used for identifying the error in a standardized manner across the gateway's services\n", "maxLength" : 100, "example" : null }, "error_message" : { "type" : "string", "deprecated" : false, "description" : "A message provided by the gateway that describes the nature of the error encountered\n", "maxLength" : 65000, "example" : null }, "decline_code" : { "type" : "string", "deprecated" : false, "description" : "When a transaction is declined, this code is provided by the gateway to specify the reason for the decline\n", "maxLength" : 100, "example" : null }, "decline_message" : { "type" : "string", "deprecated" : false, "description" : "This message gives a descriptive explanation of the reason for the transaction's decline\n", "maxLength" : 65000, "example" : null }, "network_error_code" : { "type" : "string", "deprecated" : false, "description" : "This code represents errors that originate from the payment network (such as Visa, MasterCard, and more). It is different from the gateway error code and is specific to the network's error-handling system\n", "maxLength" : 100, "example" : null }, "network_error_message" : { "type" : "string", "deprecated" : false, "description" : "This the network related error message from the gateway, this is a detailed message provided by the payment network explaining the nature of the network error encountered\n", "maxLength" : 65000, "example" : null }, "error_field" : { "type" : "string", "deprecated" : false, "description" : "This parameter indicates which specific data field or attribute in the request caused the error\n", "maxLength" : 100, "example" : null }, "recommendation_code" : { "type" : "string", "deprecated" : false, "description" : "After an error has occurred, the gateway or payment network may provide a recommendation code. This code suggests a course of action or remedy that you can follow to resolve the issue\n", "maxLength" : 100, "example" : null }, "recommendation_message" : { "type" : "string", "deprecated" : false, "description" : "This message is intended to provide guidance or suggestions on action or remedy that you can follow to resolve the issue\n", "maxLength" : 65000, "example" : null }, "processor_error_code" : { "type" : "string", "deprecated" : false, "description" : "This code is provided by the payment processor (the entity that handles the transaction between the bank accounts and the payment networks) and indicates errors that occur at this stage of the payment process\n", "maxLength" : 100, "example" : null }, "processor_error_message" : { "type" : "string", "deprecated" : false, "description" : "This message describes the specific error that the payment processor encountered\n", "maxLength" : 65000, "example" : null }, "error_cause_id" : { "type" : "string", "deprecated" : false, "description" : "A [Chargebee-defined code](/docs/api/errors)\nthat corresponds to the specific error encountered during the request. This code helps in identifying and standardizing the error across different gateway services for consistent error handling.\n", "maxLength" : 150, "example" : null }, "processor_advice_code" : { "type" : "string", "deprecated" : false, "description" : "An advice code from the payment gateway or network that indicates how to handle a card decline. For example, the value try_again_later means you can retry the transaction.
Unbilled charge represents the charges that are held by passing invoice_immediately in various operations such as update subscription, add charge, create subscription, etc. Learn more.
If any invoice is to be created for a subscription all the unbilled charges associated with the subscription will be included in that invoice.
If any invoice is to be created for a customer, all the unbilled charges associated with its subscriptions will be included in that invoice.
Any automatic invoice creation like renewal, activation, etc., will include the unbilled charges.
Subscriptions are invoiced at the start of every term based on the recurring items and charged immediately against the customer's credit card if 'auto_collection' is turned 'on', otherwise the resulting invoice will be created as 'Payment Due'.
If consolidated invoicing is enabled, the charges during the subscription renewals/activations will be held and consolidated at the last renewal/activation that takes place on that particular day.
The decimal representation of the amount for the charge, in major units of the currency. Typically equals to unit_amount_in_decimal\nx quantity_in_decimal.\nReturned when multi-decimal pricing\nis enabled.
The price of the tier if the charge model is a stairtstep\npricing , or the price of each unit in the tier if the charge model is tiered\n/volume\npricing.
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal\nof the next lower tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep\nand multi-decimal pricing\nis enabled.
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal\nof the next higher tier. Returned only when the line_items.pricing_model\nis tiered\n, volume\nor stairstep and multi-decimal pricing\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
The decimal representation of the per-unit price for the tier when the pricing_model\nis tiered\nor volume.\nWhen the pricing_model\nis stairstep\n, it is the decimal representation of the total price for line_item.\nThe value is in major units of the currency. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
Pricing type for the tier.
\n* flat_fee -Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the stairstep\npricing model, pricing_type\nwill be set to flat_fee\nby default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier.
Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2).
\n* package -Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20).
", "enum" : [ "per_unit", "flat_fee", "package" ], "example" : null }, "package_size" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Package size for the tier when pricing type is package.\nSpecify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
The Usages API is used to record usage for metered item prices in a subscription. This API is only applicable when Automated Metered Billing is enabled in Chargebee.
Metered items are those that are billed based on the service usage. Common examples include:
An item is marked metered by setting its metered attribute as true. Only recurring items can be can be set as metered. Recurring items are those of type plan or addon. A subscription can have both metered and non-metered items. The usages API (described in this page), is used to add, retrieve and delete usages for the metered items in a subscription.
While non-metered items are invoiced in a prepaid manner at the beginning of each billing cycle; for metered items, the charges are raised at the end of the billing term (postpaid). During the course of the billing period, usages can be added as and when they occur. For a given subscription_id and item_price_id, there can be only one usage record for a specific usage_date. At the end of each term, the invoice is generated with status as pending. Any remaining usage records can continue to be added to the subscription until the invoice closes automatically or is closed via an API call. If a usage record has erroneous information and you want to correct it, delete the usage and add it again.
Max Usages
The time at which this usage occurred. Chargebee bills only those usages whose\nusage_date\nfalls within a time when the subscription status\nwas active\nor non_renewing.\nHowever, the remaining usage records are still stored and are\nretrievable.
Note:\nIf usage_date\ncorresponds to a time already invoiced, then it is stored but never invoiced unless the invoice is regenerated\n.
When the usage has been invoiced, this is the id\nof the invoice.\nThis is cleared when the invoice is voided\nor deleted.
When the usage has been invoiced, this is the id\nof the invoice.line_item\nthat the usage is for. This is cleared when the invoice is voided\nor deleted\n.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
Usage charge represents the current, unbilled usage for a metered feature in a subscription within its active usage period.\nEach usage charge reflects usage accumulated from the start of the current usage period up to the time of the request.\nIt includes:
feature_id)included_usage)total_usage)on_demand_usage, metered_item_price_id, amount)usage_from, usage_to) used to compute the usageAn identifier used by the Chargebee's customer to distinguish between multiple events generated at the same timestamp for a single subscription_id.\nThe combination of usage_timestamp, subscription_id, and deduplication_id uniquely identifies each event.
Example:\nIf 3 events are generated for subscription_id = sub-1 at 2025-04-01T00:00:00.000Z, each event must have a distinct deduplication_id.
The timestamp indicating when this usage occurred, represented as Epoch\ntime in milliseconds\n.\nExample: 1738732394123\nrepresents the timestamp for February 5, 2025, at 05:13:14.123 UTC.
Note:\nThe timestamp must be within the last 12 hours\n.
A schema-less field that accepts any JSON-formatted data to define the attributes of the ingested event. It is a requirement to structure the data in a flat format wherever possible for better compatibility with downstream processing.\nWe strongly encourage using unique field names-particularly for fields intended for metering purposes. This approach enhances clarity and maintainability in the future.\nFor example, a field named status,
Can represent string values such as accepted or processing in one context.
In another scenario, it might hold numeric values, such as HTTP response codes like 200, 300, or 400.
Note:
Represents a file containing usage events that has been uploaded for processing.\n
Follow these steps to upload usage event files:
Step 1: Request an usage_file object using the upload endpoint. This returns an url.
Step 2: Create a CSV file containing the usage event records. Ensure that the file meets the expected format and complies with the file upload constraints. Only text/csv files are supported.
Step 3: Upload the CSV file using the returned url.\nMake an HTTP PUT request to the upload URL. Include the file in the request body as binary data (raw file content).
Step 4: Check the uploaded usage_file_status using the retrieve_file_processing_status endpoint.
Important\n:\nLearn more about ingesting usage events from Amazon S3.
_ and hyphens -..csv.To process more usage events than the limit mentioned above, contact Chargebee Support
| deduplication_id | subscription_id | usage_timestamp | input_tokens | output_tokens |
| 123e4567-e89b-12d3 | Sub-01 | 1741156511000 | 100 | 100 |
| 987f6543-b21c-34a5 | Sub-02 | 1741156511001 | 859 | 194 |
Learn more about deduplication_id, subscription_id, and usage_timestamp.
Each row must include deduplication_id, subscription_id, and usage_timestamp. Rows missing any of these fields are flagged as failed events.
Any top-level fields in the event row that are not a recognized field (deduplication_id, subscription_id, and usage_timestamp) will automatically be added to the properties.
Field Naming Guidelines: Ensure that your file's column headers follow the required naming rules to avoid processing issues:
\na-z)May include:
\na-z)0-9)_)| Valid Examples | Invalid Examples |
input_tokens | InputTokens |
output_tokens | Output Tokens |
feature_usage_1 | 123output |
output_value | output@value |
input_value | input-value |
When uploading a usage events file using the API, certain validation checks are performed. If issues are detected, the upload or processing may fail. The following sections explain the possible error scenarios and how they are handled.
| Error Code | Description |
|---|---|
INVALID_FILE | This error occurs in the following scenarios:
|
DUPLICATE_COLUMNS | This error occurs when the file contains duplicate column headers, which must be unique. Error Message: "Duplicate columns found: [list of duplicates]. Please remove duplicates from your file before uploading again." |
RECORD_LIMIT_EXCEEDED | This error occurs when the number of records in the uploaded file exceeds the system-defined limit. The [limit] placeholder specifies the maximum allowed records. Error Message: "The number of records exceeds the allowed limit of [limit]. Please reduce the number of records in the file and try uploading again." |
PARTIAL_FAILURE | This error indicates that some records in the file failed to process, while others were processed successfully. Review the failed records in the UI or failed queue for more details. Error Message: "Some records in the file could not be processed successfully. Please check the failed records in the [UI/Failed Queue] for more details." |
COMPLETE_FAILURE | This error indicates that all records in the uploaded file failed to process. Review the file, fix the issues, and try uploading it again. Error Message: "All records in the file failed to process. Please check the failed records in the [UI/Failed Queue] for more details." |
INVALID_COLUMNS | This error indicates that the file contains invalid column headers. Error Message: "Invalid columns found: [list of invalid headers]. Please correct column names in your file before uploading again." |
Note:\nUsage events flagged as failed appear in the Usages > Failed Events\nsection of the Admin UI Dashboard.
Indicates the format of a file.
\nNote:\nCurrently, only text/csv\nis supported.
Pre-signed URL for the error_file\ncontaining error_codes.\nThe link is valid for 60 minutes.
The total usage aggregated over the reporting window defined by aggregated_from and aggregated_to. The aggregation is performed based on the aggregation method configured in Billing.
Product variant is deleted or not. If the value is true\nthen the product variant has been deleted else it exists. Once the product variant is deleted, you can reuse the product variant id\nand name\n.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
Pass values of the option_values\n.
Type of the credit transfer
\n* eu_automated_bank_transfer -EU Automated Bank Transfer
\n* ach_credit -ACH Credit Transfer
\nThis scheme is deprecated. Instead of ach_credit\nuse us_automated_bank_transfer\n.
UK Automated Bank Transfer
\n* mx_automated_bank_transfer -MX Automated Bank Transfer
\n* jp_automated_bank_transfer -JP Automated Bank Transfer
\n* us_automated_bank_transfer -US Automated Bank Transfer
\n* sepa_credit -SEPA Credit Transfer
\nThis scheme is deprecated. Instead of sepa_credit\nuse eu_automated_bank_transfer\n.
Version number of this resource. The resource_version\nis updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
Indicates whether the webhook endpoint is disabled. If true\n, the endpoint is disabled; if false\n, it is enabled.
Indicates the response schema used in the webhook payload, based on the product catalog version configured for the site.
\nNote\nThis field is only applicable if the site is in compat mode.
The webhook payload uses a schema compatible with both Product Catalog 1.0 and 2.0. This is applicable only to sites automatically upgraded to Product Catalog 2.0.
\n* items -The webhook payload follows the Product Catalog 2.0\nschema and uses the Items API model\n.
\n* plans_addons -The webhook payload follows the Product Catalog 1.0\nschema and uses the Plans\nand Addons\nmodel.
", "enum" : [ "plans_addons", "items", "compat" ], "example" : null }, "enabled_events" : { "type" : "array", "deprecated" : false, "description" : "The types of events that trigger this webhook. For a complete list, see [event types](/docs/api/webhook_endpoints)\n.\n", "items" : { "type" : "string", "deprecated" : false, "description" : "The types of events that trigger this webhook. For a complete list, see [event types](/docs/api/webhook_endpoints)\n.\n", "enum" : [ "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "payment_schedules_created", "payment_schedules_updated", "payment_schedule_scheme_created", "payment_schedule_scheme_deleted", "subscription_renewal_reminder", "add_usages_reminder", "payment_due_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "item_family_created", "item_family_updated", "item_family_deleted", "item_created", "item_updated", "item_deleted", "item_price_created", "item_price_updated", "item_price_deleted", "attached_item_created", "attached_item_updated", "attached_item_deleted", "differential_price_created", "differential_price_updated", "differential_price_deleted", "feature_created", "feature_updated", "feature_deleted", "feature_activated", "feature_reactivated", "feature_archived", "item_entitlements_updated", "entitlement_overrides_updated", "entitlement_overrides_removed", "item_entitlements_removed", "entitlement_overrides_auto_removed", "subscription_entitlements_created", "subscription_entitlements_updated", "business_entity_created", "business_entity_updated", "business_entity_deleted", "customer_business_entity_changed", "subscription_business_entity_changed", "purchase_created", "voucher_created", "voucher_expired", "voucher_create_failed", "item_price_entitlements_updated", "item_price_entitlements_removed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "price_variant_created", "price_variant_updated", "price_variant_deleted", "customer_entitlements_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "usage_file_ingested", "omnichannel_subscription_item_pause_scheduled", "omnichannel_subscription_moved_in", "omnichannel_transaction_created", "alert_status_changed", "omnichannel_subscription_item_updated", "omnichannel_subscription_item_recovered" ], "example" : null }, "example" : null } }, "required" : [ "api_version", "disabled", "id", "name", "primary_url", "url" ], "example" : null }, "WindowSize" : { "type" : "string", "deprecated" : false, "enum" : [ "month", "week", "day", "hour", "minute" ], "example" : null } }, "parameters" : { "payment-voucher-id" : { "name" : "payment-voucher-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "item-price-id" : { "name" : "item-price-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "reason-code-id" : { "name" : "reason-code-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "differential-price-id" : { "name" : "differential-price-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "tax-withheld-id" : { "name" : "tax-withheld-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "sales-order-id" : { "name" : "sales-order-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "in-app-subscription-app-id" : { "name" : "in-app-subscription-app-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "quote-id" : { "name" : "quote-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "limit" : { "name" : "limit", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.", "x-cb-is-pagination-parameter" : true, "maximum" : 100, "minimum" : 1, "example" : null } }, "include_deleted" : { "name" : "include_deleted", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "default" : false, "description" : "Indicates whether to include deleted objects in the list. The deleted objects have the attribute `deleted` as `true`." } }, "chargebee-request-origin-ip" : { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, "coupon-code-code" : { "name" : "coupon-code-code", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "pc2-migration-item-family-id" : { "name" : "pc2-migration-item-family-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "chargebee-business-entity-id" : { "name" : "chargebee-business-entity-id", "in" : "header", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.", "maxLength" : 50 } }, "offset" : { "name" : "offset", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.", "x-cb-is-pagination-parameter" : true, "maxLength" : 1000, "example" : null } }, "entitlement-override-id" : { "name" : "entitlement-override-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "subscription-id" : { "name" : "subscription-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "hosted-page-id" : { "name" : "hosted-page-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "credit-note-id" : { "name" : "credit-note-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "virtual-bank-account-id" : { "name" : "virtual-bank-account-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "chargebee-event-webhook" : { "name" : "chargebee-event-webhook", "in" : "header", "description" : " skip only webhooks", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : " skip only webhooks", "enum" : [ "all-disabled" ] } }, "e-invoicing-country-country" : { "name" : "e-invoicing-country-country", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "coupon-set-id" : { "name" : "coupon-set-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "non-subscription-app-id" : { "name" : "non-subscription-app-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "business-entity-transfer-id" : { "name" : "business-entity-transfer-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "portal-session-id" : { "name" : "portal-session-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "attached-item-id" : { "name" : "attached-item-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "plan-id" : { "name" : "plan-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "chargebee-request-origin-user-encoded" : { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, "ruleset-id" : { "name" : "ruleset-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "meter-id" : { "name" : "meter-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "business-entity-id" : { "name" : "business-entity-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "item-id" : { "name" : "item-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "item-billing-metric-id" : { "name" : "item-billing-metric-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "subscription-entitlement-id" : { "name" : "subscription-entitlement-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "customer-id" : { "name" : "customer-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "cust-payment-source-id" : { "name" : "cust-payment-source-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "site-currency-id" : { "name" : "site-currency-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "chargebee-request-origin-device" : { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request", "example" : "Android" } }, "thunking-plan-id" : { "name" : "thunking-plan-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "tp-site-user-domain" : { "name" : "tp-site-user-domain", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "payment-schedule-scheme-id" : { "name" : "payment-schedule-scheme-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "event-id" : { "name" : "event-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "async-response-id" : { "name" : "async-response-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "site-owner-id" : { "name" : "site-owner-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "rule-id" : { "name" : "rule-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "time-machine-name" : { "name" : "time-machine-name", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "item-family-id" : { "name" : "item-family-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "omnichannel-subscription-item-id" : { "name" : "omnichannel-subscription-item-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "product-id" : { "name" : "product-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "omnichannel-one-time-order-id" : { "name" : "omnichannel-one-time-order-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "invoice-id" : { "name" : "invoice-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "feature-id" : { "name" : "feature-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "transaction-id" : { "name" : "transaction-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "business-rule-id" : { "name" : "business-rule-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "offer-fulfillment-id" : { "name" : "offer-fulfillment-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "cb-token-id" : { "name" : "cb-token-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "purchase-id" : { "name" : "purchase-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "chargebee-event-email" : { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails", "enum" : [ "all-disabled" ] } }, "omnichannel-subscription-id" : { "name" : "omnichannel-subscription-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "price-variant-id" : { "name" : "price-variant-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "comment-id" : { "name" : "comment-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "webhook-endpoint-id" : { "name" : "webhook-endpoint-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "pc2-migration-item-id" : { "name" : "pc2-migration-item-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "usage-file-id" : { "name" : "usage-file-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "coupon-id" : { "name" : "coupon-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "alert-id" : { "name" : "alert-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "recorded-purchase-id" : { "name" : "recorded-purchase-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "payment-intent-id" : { "name" : "payment-intent-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "tp-integ-sync-detail-id" : { "name" : "tp-integ-sync-detail-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "order-id" : { "name" : "order-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "pc2-migration-item-price-id" : { "name" : "pc2-migration-item-price-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "product-variant-id" : { "name" : "product-variant-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "account-credit-id" : { "name" : "account-credit-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "chargebee-event-actions" : { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events", "enum" : [ "all-disabled" ] } }, "pc2-migration-id" : { "name" : "pc2-migration-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "async-api-request-id" : { "name" : "async-api-request-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "chargebee-request-origin-user" : { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.", "example" : "user@example.com" } }, "ramp-id" : { "name" : "ramp-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "custom-pricing-unit-id" : { "name" : "custom-pricing-unit-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "export-id" : { "name" : "export-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "gift-id" : { "name" : "gift-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "unbilled-charge-id" : { "name" : "unbilled-charge-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "addon-id" : { "name" : "addon-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } }, "securitySchemes" : { "BasicAuth" : { "type" : "http", "scheme" : "basic" } } }, "jsonSchemaDialect" : "https://spec.openapis.org/oas/3.1/dialect/base", "webhooks" : { "subscription_pause_scheduled" : { "description" : "Triggered when the subscription is scheduled to pause.
", "post" : { "summary" : "Triggered when the subscription is scheduled to pause.", "description" : "Triggered when the subscription is scheduled to pause.
", "operationId" : "onSubscription_pause_scheduledWebhook", "requestBody" : { "description" : "Payload for subscription_pause_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionPauseScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "customer_business_entity_changed" : { "post" : { "summary" : "Triggered when a customer's business entity is changed", "operationId" : "onCustomer_business_entity_changedWebhook", "requestBody" : { "description" : "Payload for customer_business_entity_changed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerBusinessEntityChangedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_advance_invoice_schedule_added" : { "description" : "Triggered when advance invoice is scheduled for a subscription.
", "post" : { "summary" : "Triggered when advance invoice is scheduled for a subscription.", "description" : "Triggered when advance invoice is scheduled for a subscription.
", "operationId" : "onSubscription_advance_invoice_schedule_addedWebhook", "requestBody" : { "description" : "Payload for subscription_advance_invoice_schedule_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionAdvanceInvoiceScheduleAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_expired" : { "description" : "Triggered when a gift expires.
", "post" : { "summary" : "Triggered when a gift expires.", "description" : "Triggered when a gift expires.
", "operationId" : "onGift_expiredWebhook", "requestBody" : { "description" : "Payload for gift_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "tax_withheld_deleted" : { "description" : "Triggered when a tax withheld is deleted.
", "post" : { "summary" : "Triggered when a tax withheld is deleted.", "description" : "Triggered when a tax withheld is deleted.
", "operationId" : "onTax_withheld_deletedWebhook", "requestBody" : { "description" : "Payload for tax_withheld_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxWithheldDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "unbilled_charges_deleted" : { "description" : "Triggered when unbilled charges are deleted
", "post" : { "summary" : "Triggered when unbilled charges are deleted", "description" : "Triggered when unbilled charges are deleted
", "operationId" : "onUnbilled_charges_deletedWebhook", "requestBody" : { "description" : "Payload for unbilled_charges_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnbilledChargesDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_updated" : { "description" : "Triggered when a coupon is changed.
", "post" : { "summary" : "Triggered when a coupon is changed.", "description" : "Triggered when a coupon is changed.
", "operationId" : "onCoupon_updatedWebhook", "requestBody" : { "description" : "Payload for coupon_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "product_updated" : { "post" : { "summary" : "Triggered when a product resource is updated successfully", "operationId" : "onProduct_updatedWebhook", "requestBody" : { "description" : "Payload for product_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : true } }, "omnichannel_subscription_item_reactivated" : { "description" : "Triggered when an omnichannel subscription item's refund is reversed.
", "post" : { "summary" : "Triggered when an omnichannel subscription item's refund is reversed", "description" : "Triggered when an omnichannel subscription item's refund is reversed.
", "operationId" : "onOmnichannel_subscription_item_reactivatedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_reactivated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemReactivatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_renewed" : { "description" : "Triggered when an omnichannel subscription item is renewed.
", "post" : { "summary" : "Triggered when an omnichannel subscription item is renewed", "description" : "Triggered when an omnichannel subscription item is renewed.
", "operationId" : "onOmnichannel_subscription_item_renewedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_renewed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemRenewedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "unbilled_charges_created" : { "description" : "Triggered when unbilled charges are created
", "post" : { "summary" : "Triggered when unbilled charges are created", "description" : "Triggered when unbilled charges are created
", "operationId" : "onUnbilled_charges_createdWebhook", "requestBody" : { "description" : "Payload for unbilled_charges_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnbilledChargesCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_resumed" : { "description" : "Triggered when the subscription is resumed.
", "post" : { "summary" : "Triggered when the subscription is resumed.", "description" : "Triggered when the subscription is resumed.
", "operationId" : "onSubscription_resumedWebhook", "requestBody" : { "description" : "Payload for subscription_resumed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionResumedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_one_time_order_item_cancelled" : { "post" : { "summary" : "Triggered when an omnichannel one time order item is cancelled", "operationId" : "onOmnichannel_one_time_order_item_cancelledWebhook", "requestBody" : { "description" : "Payload for omnichannel_one_time_order_item_cancelled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelOneTimeOrderItemCancelledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_cancelled" : { "description" : "Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.
", "post" : { "summary" : "Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.", "description" : "Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.
", "operationId" : "onSubscription_cancelledWebhook", "requestBody" : { "description" : "Payload for subscription_cancelled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCancelledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "item_entitlements_removed" : { "description" : "One or more item_entitlements were removed for an item or a feature.
One or more item_entitlements were removed for an item or a feature.
Triggered when a business entity is created
", "post" : { "summary" : "Triggered when a business entity is created", "description" : "Triggered when a business entity is created
", "operationId" : "onBusiness_entity_createdWebhook", "requestBody" : { "description" : "Payload for business_entity_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BusinessEntityCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_set_updated" : { "description" : "Triggered when a coupon set is updated.
", "post" : { "summary" : "Triggered when a coupon set is updated.", "description" : "Triggered when a coupon set is updated.
", "operationId" : "onCoupon_set_updatedWebhook", "requestBody" : { "description" : "Payload for coupon_set_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponSetUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "differential_price_updated" : { "description" : "Triggered when a differential price is updated.
", "post" : { "summary" : "Triggered when a differential price is updated.", "description" : "Triggered when a differential price is updated.
", "operationId" : "onDifferential_price_updatedWebhook", "requestBody" : { "description" : "Payload for differential_price_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DifferentialPriceUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_paused" : { "post" : { "summary" : "Triggered when an omnichannel subscription item is paused", "operationId" : "onOmnichannel_subscription_item_pausedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_paused event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemPausedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "entitlement_overrides_removed" : { "description" : "Triggered when one or more entitlement_override objects are removed. This is not triggered when Chargebee removes the objects automatically upon expiry.
Triggered when one or more entitlement_override objects are removed. This is not triggered when Chargebee removes the objects automatically upon expiry.
Triggered after the subscription changes to active from another status, while the change is backdated.
Triggered after the subscription changes to active from another status, while the change is backdated.
Triggered 6 days prior to the trial period's end date.
", "post" : { "summary" : "Triggered 6 days prior to the trial period's end date.", "description" : "Triggered 6 days prior to the trial period's end date.
", "operationId" : "onSubscription_trial_end_reminderWebhook", "requestBody" : { "description" : "Payload for subscription_trial_end_reminder event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionTrialEndReminderEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_shipping_address_updated" : { "description" : "Triggered when shipping address is added or updated for a subscription.
", "post" : { "summary" : "Triggered when shipping address is added or updated for a subscription.", "description" : "Triggered when shipping address is added or updated for a subscription.
", "operationId" : "onSubscription_shipping_address_updatedWebhook", "requestBody" : { "description" : "Payload for subscription_shipping_address_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionShippingAddressUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "voucher_create_failed" : { "description" : "Triggered when the Payment voucher Creation fails.
", "post" : { "summary" : "Triggered when the Payment voucher Creation fails.", "description" : "Triggered when the Payment voucher Creation fails.
", "operationId" : "onVoucher_create_failedWebhook", "requestBody" : { "description" : "Payload for voucher_create_failed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoucherCreateFailedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_claimed" : { "description" : "Triggered when a gift is claimed.
", "post" : { "summary" : "Triggered when a gift is claimed.", "description" : "Triggered when a gift is claimed.
", "operationId" : "onGift_claimedWebhook", "requestBody" : { "description" : "Payload for gift_claimed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftClaimedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "customer_deleted" : { "description" : "Triggered when a customer is deleted.
", "post" : { "summary" : "Triggered when a customer is deleted.", "description" : "Triggered when a customer is deleted.
", "operationId" : "onCustomer_deletedWebhook", "requestBody" : { "description" : "Payload for customer_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "refund_initiated" : { "description" : "Triggered when a refund is initiated using the direct_debit payment method, or when a transaction enters the in_progress status due to asynchronous processing at the payment gateway.
Triggered when a refund is initiated using the direct_debit payment method, or when a transaction enters the in_progress status due to asynchronous processing at the payment gateway.
Triggered when an invoice has been created with date set to a value in the past. However, if the invoice is created with a pending status and the site setting is to set invoice.date to the date of closing the invoice, this event is never triggered.
", "post" : { "summary" : "Triggered when an invoice has been created with date set to a value in the past. However, if the invoice is created with a pending status and the site setting is to set invoice.date to the date of closing the invoice, this event is never triggered.", "description" : "Triggered when an invoice has been created with date set to a value in the past. However, if the invoice is created with a pending status and the site setting is to set invoice.date to the date of closing the invoice, this event is never triggered.
", "operationId" : "onInvoice_generated_with_backdatingWebhook", "requestBody" : { "description" : "Payload for invoice_generated_with_backdating event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceGeneratedWithBackdatingEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_transaction_created" : { "post" : { "summary" : "Triggered when an omnichannel transaction is created", "operationId" : "onOmnichannel_transaction_createdWebhook", "requestBody" : { "description" : "Payload for omnichannel_transaction_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelTransactionCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "add_usages_reminder" : { "description" : "Triggered on one day before term end of every month.
", "post" : { "summary" : "Triggered on one day before term end of every month.", "description" : "Triggered on one day before term end of every month.
", "operationId" : "onAdd_usages_reminderWebhook", "requestBody" : { "description" : "Payload for add_usages_reminder event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddUsagesReminderEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "voucher_created" : { "description" : "Triggered when a Payment voucher is created.
", "post" : { "summary" : "Triggered when a Payment voucher is created.", "description" : "Triggered when a Payment voucher is created.
", "operationId" : "onVoucher_createdWebhook", "requestBody" : { "description" : "Payload for voucher_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoucherCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "rule_updated" : { "post" : { "summary" : "Triggered when a rule is updated", "operationId" : "onRule_updatedWebhook", "requestBody" : { "description" : "Payload for rule_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RuleUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_schedules_created" : { "post" : { "summary" : "Event triggered when payment schedules are created for an invoice.", "operationId" : "onPayment_schedules_createdWebhook", "requestBody" : { "description" : "Payload for payment_schedules_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSchedulesCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "feature_activated" : { "description" : "Triggered when a feature status transitions to active for the first time.
Triggered when a feature status transitions to active for the first time.
Triggered when a payment source is deleted at Chargebee.
", "post" : { "summary" : "Triggered when a payment source is deleted at Chargebee.", "description" : "Triggered when a payment source is deleted at Chargebee.
", "operationId" : "onPayment_source_locally_deletedWebhook", "requestBody" : { "description" : "Payload for payment_source_locally_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSourceLocallyDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "invoice_generated" : { "description" : "Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.
", "post" : { "summary" : "Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.", "description" : "Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.
", "operationId" : "onInvoice_generatedWebhook", "requestBody" : { "description" : "Payload for invoice_generated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceGeneratedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "voucher_expired" : { "description" : "Triggered when a Payment voucher is Expired.
", "post" : { "summary" : "Triggered when a Payment voucher is Expired.", "description" : "Triggered when a Payment voucher is Expired.
", "operationId" : "onVoucher_expiredWebhook", "requestBody" : { "description" : "Payload for voucher_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoucherExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "authorization_succeeded" : { "description" : "Triggered when a authorization transaction is created.
", "post" : { "summary" : "Triggered when a authorization transaction is created.", "description" : "Triggered when a authorization transaction is created.
", "operationId" : "onAuthorization_succeededWebhook", "requestBody" : { "description" : "Payload for authorization_succeeded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationSucceededEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_scheduled" : { "description" : "Triggered when a new gift is created.
", "post" : { "summary" : "Triggered when a new gift is created.", "description" : "Triggered when a new gift is created.
", "operationId" : "onGift_scheduledWebhook", "requestBody" : { "description" : "Payload for gift_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_changes_scheduled" : { "description" : "Triggered when subscription changes are scheduled for later. Changes will be applied at the end of current term.
", "post" : { "summary" : "Triggered when subscription changes are scheduled for later. Changes will be applied at the end of current term.", "description" : "Triggered when subscription changes are scheduled for later. Changes will be applied at the end of current term.
", "operationId" : "onSubscription_changes_scheduledWebhook", "requestBody" : { "description" : "Payload for subscription_changes_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionChangesScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_changed_with_backdating" : { "description" : "Triggered when a subscription is changed with changes_scheduled_at set to a value in the past.
", "post" : { "summary" : "Triggered when a subscription is changed with changes_scheduled_at set to a value in the past.", "description" : "Triggered when a subscription is changed with changes_scheduled_at set to a value in the past.
", "operationId" : "onSubscription_changed_with_backdatingWebhook", "requestBody" : { "description" : "Payload for subscription_changed_with_backdating event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionChangedWithBackdatingEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "variant_created" : { "post" : { "summary" : "Triggered when a product variant resource is created successfully", "operationId" : "onVariant_createdWebhook", "requestBody" : { "description" : "Payload for variant_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VariantCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : true } }, "omnichannel_subscription_item_changed" : { "post" : { "summary" : "Triggered when an omnichannel subscription item is changed", "operationId" : "onOmnichannel_subscription_item_changedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_changed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemChangedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_unclaimed" : { "description" : "Triggered when a new gift is unclaimed and is ready to be claimed.
", "post" : { "summary" : "Triggered when a new gift is unclaimed and is ready to be claimed.", "description" : "Triggered when a new gift is unclaimed and is ready to be claimed.
", "operationId" : "onGift_unclaimedWebhook", "requestBody" : { "description" : "Payload for gift_unclaimed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftUnclaimedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "virtual_bank_account_added" : { "description" : "Triggered when a virtual bank account is added.
", "post" : { "summary" : "Triggered when a virtual bank account is added.", "description" : "Triggered when a virtual bank account is added.
", "operationId" : "onVirtual_bank_account_addedWebhook", "requestBody" : { "description" : "Payload for virtual_bank_account_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VirtualBankAccountAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_intent_created" : { "description" : "Triggered when a payment intent is created.
", "post" : { "summary" : "Triggered when a payment intent is created.", "description" : "Triggered when a payment intent is created.
", "operationId" : "onPayment_intent_createdWebhook", "requestBody" : { "description" : "Payload for payment_intent_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentIntentCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_updated" : { "description" : "Triggered when an omnichannel subscription item is updated.
", "post" : { "summary" : "Triggered when an omnichannel subscription item is updated", "description" : "Triggered when an omnichannel subscription item is updated.
", "operationId" : "onOmnichannel_subscription_item_updatedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "credit_note_created_with_backdating" : { "description" : "Triggered when a credit note is created such that generated_at is a value in the past.
", "post" : { "summary" : "Triggered when a credit note is created such that generated_at is a value in the past.", "description" : "Triggered when a credit note is created such that generated_at is a value in the past.
", "operationId" : "onCredit_note_created_with_backdatingWebhook", "requestBody" : { "description" : "Payload for credit_note_created_with_backdating event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreditNoteCreatedWithBackdatingEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "contract_term_terminated" : { "description" : "Triggered when contract term is terminated.
", "post" : { "summary" : "Triggered when contract term is terminated.", "description" : "Triggered when contract term is terminated.
", "operationId" : "onContract_term_terminatedWebhook", "requestBody" : { "description" : "Payload for contract_term_terminated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractTermTerminatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "item_family_updated" : { "description" : "Triggered when an item family is updated.
", "post" : { "summary" : "Triggered when an item family is updated.", "description" : "Triggered when an item family is updated.
", "operationId" : "onItem_family_updatedWebhook", "requestBody" : { "description" : "Payload for item_family_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemFamilyUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_created" : { "description" : "Triggered when an order is generated.
", "post" : { "summary" : "Triggered when an order is generated.", "description" : "Triggered when an order is generated.
", "operationId" : "onOrder_createdWebhook", "requestBody" : { "description" : "Payload for order_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "price_variant_deleted" : { "description" : "Triggered when a price variant resource is deleted successfully
", "post" : { "summary" : "Triggered when a price variant is deleted.", "description" : "Triggered when a price variant resource is deleted successfully
", "operationId" : "onPrice_variant_deletedWebhook", "requestBody" : { "description" : "Payload for price_variant_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PriceVariantDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "alert_status_changed" : { "description" : "Triggered when an alert's runtime status for a subscription changes between IN_ALARM and WITHIN_LIMIT.\nThis indicates a change in the subscription's usage relative to the alert threshold and applies only to usage-based billing.
Triggered when an alert's runtime status for a subscription changes between IN_ALARM and WITHIN_LIMIT.\nThis indicates a change in the subscription's usage relative to the alert threshold and applies only to usage-based billing.
Triggered when the subscription movement fails during moving in or out of a subscription from one customer to another asynchronously.
", "post" : { "summary" : "Triggered when a subscription movement failed", "description" : "Triggered when the subscription movement fails during moving in or out of a subscription from one customer to another asynchronously.
", "operationId" : "onSubscription_movement_failedWebhook", "requestBody" : { "description" : "Payload for subscription_movement_failed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionMovementFailedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "customer_moved_in" : { "description" : "Triggered when a customer is copied from another site.
", "post" : { "summary" : "Triggered when a customer is copied from another site.", "description" : "Triggered when a customer is copied from another site.
", "operationId" : "onCustomer_moved_inWebhook", "requestBody" : { "description" : "Payload for customer_moved_in event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerMovedInEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_advance_invoice_schedule_updated" : { "description" : "Triggered when scheduled advance invoice is updated for a subscription.
", "post" : { "summary" : "Triggered when scheduled advance invoice is updated for a subscription.", "description" : "Triggered when scheduled advance invoice is updated for a subscription.
", "operationId" : "onSubscription_advance_invoice_schedule_updatedWebhook", "requestBody" : { "description" : "Payload for subscription_advance_invoice_schedule_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionAdvanceInvoiceScheduleUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "item_deleted" : { "description" : "Triggered when an item is deleted.
", "post" : { "summary" : "Triggered when an item is deleted.", "description" : "Triggered when an item is deleted.
", "operationId" : "onItem_deletedWebhook", "requestBody" : { "description" : "Payload for item_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_ramp_drafted" : { "description" : "Triggered when a ramp is moved to draft status.
", "post" : { "summary" : "Triggered when a ramp is drafted.", "description" : "Triggered when a ramp is moved to draft status.
", "operationId" : "onSubscription_ramp_draftedWebhook", "requestBody" : { "description" : "Payload for subscription_ramp_drafted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionRampDraftedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "dunning_updated" : { "post" : { "summary" : "Triggered when dunning is paused for an invoice", "operationId" : "onDunning_updatedWebhook", "requestBody" : { "description" : "Payload for dunning_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DunningUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_recovered" : { "description" : "Triggered when an omnichannel subscription item recovers from a billing issue and is active again.
", "post" : { "summary" : "Triggered when an omnichannel subscription item is recovered from grace period or dunning", "description" : "Triggered when an omnichannel subscription item recovers from a billing issue and is active again.
", "operationId" : "onOmnichannel_subscription_item_recoveredWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_recovered event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemRecoveredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "item_entitlements_updated" : { "description" : "One or more entitlements were added or updated for an item.
One or more entitlements were added or updated for an item.
Triggered when a nonce is consumed.
", "post" : { "summary" : "Triggered when a nonce is consumed.", "description" : "Triggered when a nonce is consumed.
", "operationId" : "onToken_consumedWebhook", "requestBody" : { "description" : "Payload for token_consumed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TokenConsumedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "hierarchy_deleted" : { "description" : "Triggered when a hierarchy is deleted.
", "post" : { "summary" : "Triggered when a hierarchy is deleted.", "description" : "Triggered when a hierarchy is deleted.
", "operationId" : "onHierarchy_deletedWebhook", "requestBody" : { "description" : "Payload for hierarchy_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HierarchyDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_cancellation_scheduled" : { "description" : "Triggered when subscription is scheduled to cancel at end of current term.
", "post" : { "summary" : "Triggered when subscription is scheduled to cancel at end of current term.", "description" : "Triggered when subscription is scheduled to cancel at end of current term.
", "operationId" : "onSubscription_cancellation_scheduledWebhook", "requestBody" : { "description" : "Payload for subscription_cancellation_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCancellationScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_renewed" : { "description" : "Triggered when the subscription is renewed from the current term.
", "post" : { "summary" : "Triggered when the subscription is renewed from the current term.", "description" : "Triggered when the subscription is renewed from the current term.
", "operationId" : "onSubscription_renewedWebhook", "requestBody" : { "description" : "Payload for subscription_renewed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionRenewedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "feature_updated" : { "description" : "Triggered when a feature is updated. Note: This event is not triggered when only the status of the feature has changed.
Triggered when a feature is updated. Note: This event is not triggered when only the status of the feature has changed.
Triggered when a feature is deleted.
Triggered when a feature is deleted.
Triggered when an item family is created.
", "post" : { "summary" : "Triggered when an item family is created.", "description" : "Triggered when an item family is created.
", "operationId" : "onItem_family_createdWebhook", "requestBody" : { "description" : "Payload for item_family_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemFamilyCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_scheduled_change_removed" : { "description" : "Triggered when an omnichannel subscription item scheduled change is removed.
", "post" : { "summary" : "Triggered when an omnichannel subscription item scheduled change is removed", "description" : "Triggered when an omnichannel subscription item scheduled change is removed.
", "operationId" : "onOmnichannel_subscription_item_scheduled_change_removedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_scheduled_change_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemScheduledChangeRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_resumed" : { "post" : { "summary" : "Triggered when an omnichannel subscription item is resumed", "operationId" : "onOmnichannel_subscription_item_resumedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_resumed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemResumedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "purchase_created" : { "description" : "Triggered when a purchase resource is created successfully
", "post" : { "summary" : "Triggered when a purchase resource is created successfully", "description" : "Triggered when a purchase resource is created successfully
", "operationId" : "onPurchase_createdWebhook", "requestBody" : { "description" : "Payload for purchase_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PurchaseCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "entitlement_overrides_updated" : { "description" : "One or more entitlement_overrides for a subscription were added or updated.
One or more entitlement_overrides for a subscription were added or updated.
Triggered when an item family is deleted.
", "post" : { "summary" : "Triggered when an item family is deleted.", "description" : "Triggered when an item family is deleted.
", "operationId" : "onItem_family_deletedWebhook", "requestBody" : { "description" : "Payload for item_family_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemFamilyDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_resumption_scheduled" : { "description" : "Triggered when the subscription is scheduled to resume.
", "post" : { "summary" : "Triggered when the subscription is scheduled to resume.", "description" : "Triggered when the subscription is scheduled to resume.
", "operationId" : "onSubscription_resumption_scheduledWebhook", "requestBody" : { "description" : "Payload for subscription_resumption_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionResumptionScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "feature_reactivated" : { "description" : "Triggered when a feature status transitions to active for the second time or more.
Triggered when a feature status transitions to active for the second time or more.
Triggered when coupon codes are deleted in coupon set.
", "post" : { "summary" : "Triggered when coupon codes are deleted in coupon set.", "description" : "Triggered when coupon codes are deleted in coupon set.
", "operationId" : "onCoupon_codes_deletedWebhook", "requestBody" : { "description" : "Payload for coupon_codes_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponCodesDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "card_expired" : { "description" : "Triggered when the card for a customer has expired.
", "post" : { "summary" : "Triggered when the card for a customer has expired.", "description" : "Triggered when the card for a customer has expired.
", "operationId" : "onCard_expiredWebhook", "requestBody" : { "description" : "Payload for card_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CardExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "credit_note_updated" : { "description" : "Triggered when a credit note is updated.
", "post" : { "summary" : "Triggered when a credit note is updated.", "description" : "Triggered when a credit note is updated.
", "operationId" : "onCredit_note_updatedWebhook", "requestBody" : { "description" : "Payload for credit_note_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreditNoteUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_downgraded" : { "description" : "Triggered when an omnichannel subscription item is downgraded.
", "post" : { "summary" : "Triggered when an omnichannel subscription item is downgraded", "description" : "Triggered when an omnichannel subscription item is downgraded.
", "operationId" : "onOmnichannel_subscription_item_downgradedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_downgraded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemDowngradedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "price_variant_updated" : { "description" : "Triggered when a price variant resource is updated successfully
", "post" : { "summary" : "Triggered when a price variant is updated.", "description" : "Triggered when a price variant resource is updated successfully
", "operationId" : "onPrice_variant_updatedWebhook", "requestBody" : { "description" : "Payload for price_variant_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PriceVariantUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "promotional_credits_deducted" : { "description" : "Triggered when promotional credit is deducted.
", "post" : { "summary" : "Triggered when promotional credit is deducted.", "description" : "Triggered when promotional credit is deducted.
", "operationId" : "onPromotional_credits_deductedWebhook", "requestBody" : { "description" : "Payload for promotional_credits_deducted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PromotionalCreditsDeductedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_ramp_applied" : { "description" : "Triggered when a ramp is executed successfully.
", "post" : { "summary" : "Triggered when a ramp is applied.", "description" : "Triggered when a ramp is executed successfully.
", "operationId" : "onSubscription_ramp_appliedWebhook", "requestBody" : { "description" : "Payload for subscription_ramp_applied event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionRampAppliedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_paused" : { "description" : "Triggered when the subscription is paused.
", "post" : { "summary" : "Triggered when the subscription is paused.", "description" : "Triggered when the subscription is paused.
", "operationId" : "onSubscription_pausedWebhook", "requestBody" : { "description" : "Payload for subscription_paused event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionPausedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_ready_to_process" : { "description" : "Triggered when an order reaches it's order date.
", "post" : { "summary" : "Triggered when an order reaches it's order date.", "description" : "Triggered when an order reaches it's order date.
", "operationId" : "onOrder_ready_to_processWebhook", "requestBody" : { "description" : "Payload for order_ready_to_process event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderReadyToProcessEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "feature_created" : { "description" : "Triggered when a feature is created.
Triggered when a feature is created.
Triggered when a transaction is deleted.
", "post" : { "summary" : "Triggered when a transaction is deleted.", "description" : "Triggered when a transaction is deleted.
", "operationId" : "onTransaction_deletedWebhook", "requestBody" : { "description" : "Payload for transaction_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "credit_note_created" : { "description" : "Triggered when a credit note is created.
", "post" : { "summary" : "Triggered when a credit note is created.", "description" : "Triggered when a credit note is created.
", "operationId" : "onCredit_note_createdWebhook", "requestBody" : { "description" : "Payload for credit_note_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreditNoteCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_resubscribed" : { "description" : "Triggered when an omnichannel subscription item is resubscribed.
", "post" : { "summary" : "Triggered when an omnichannel subscription item is resubscribed", "description" : "Triggered when an omnichannel subscription item is resubscribed.
", "operationId" : "onOmnichannel_subscription_item_resubscribedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_resubscribed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemResubscribedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "record_purchase_failed" : { "description" : "Triggered when the record a purchase API fails to create an omnichannel subscription.
", "post" : { "summary" : "Triggered when an omnichannel record purchase is failed", "description" : "Triggered when the record a purchase API fails to create an omnichannel subscription.
", "operationId" : "onRecord_purchase_failedWebhook", "requestBody" : { "description" : "Payload for record_purchase_failed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RecordPurchaseFailedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "item_created" : { "description" : "Triggered when an item is created.
", "post" : { "summary" : "Triggered when an item is created.", "description" : "Triggered when an item is created.
", "operationId" : "onItem_createdWebhook", "requestBody" : { "description" : "Payload for item_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "transaction_updated" : { "description" : "Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.
", "post" : { "summary" : "Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.", "description" : "Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.
", "operationId" : "onTransaction_updatedWebhook", "requestBody" : { "description" : "Payload for transaction_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "variant_deleted" : { "post" : { "summary" : "Triggered when a product variant resource is deleted successfully", "operationId" : "onVariant_deletedWebhook", "requestBody" : { "description" : "Payload for variant_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VariantDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : true } }, "mrr_updated" : { "description" : "Triggered when either of MRR or CMRR is changed.
", "post" : { "summary" : "Triggered when either of MRR or CMRR is changed.", "description" : "Triggered when either of MRR or CMRR is changed.
", "operationId" : "onMrr_updatedWebhook", "requestBody" : { "description" : "Payload for mrr_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MrrUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "unbilled_charges_invoiced" : { "description" : "Triggered when unbilled charges are invoiced
", "post" : { "summary" : "Triggered when unbilled charges are invoiced", "description" : "Triggered when unbilled charges are invoiced
", "operationId" : "onUnbilled_charges_invoicedWebhook", "requestBody" : { "description" : "Payload for unbilled_charges_invoiced event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnbilledChargesInvoicedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "item_price_updated" : { "description" : "Triggered when an item price is updated.
", "post" : { "summary" : "Triggered when an item price is updated.", "description" : "Triggered when an item price is updated.
", "operationId" : "onItem_price_updatedWebhook", "requestBody" : { "description" : "Payload for item_price_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemPriceUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_codes_updated" : { "description" : "Triggered when coupon codes are updated in coupon set.
", "post" : { "summary" : "Triggered when coupon codes are updated in coupon set.", "description" : "Triggered when coupon codes are updated in coupon set.
", "operationId" : "onCoupon_codes_updatedWebhook", "requestBody" : { "description" : "Payload for coupon_codes_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponCodesUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "virtual_bank_account_updated" : { "description" : "Triggered when the virtual bank account is updated.
", "post" : { "summary" : "Triggered when the virtual bank account is updated.", "description" : "Triggered when the virtual bank account is updated.
", "operationId" : "onVirtual_bank_account_updatedWebhook", "requestBody" : { "description" : "Payload for virtual_bank_account_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VirtualBankAccountUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "contract_term_created" : { "description" : "Triggered when contract term is created.
", "post" : { "summary" : "Triggered when contract term is created.", "description" : "Triggered when contract term is created.
", "operationId" : "onContract_term_createdWebhook", "requestBody" : { "description" : "Payload for contract_term_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractTermCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_changed" : { "description" : "Triggered when the subscription's recurring items are changed.
", "post" : { "summary" : "Triggered when the subscription's recurring items are changed.", "description" : "Triggered when the subscription's recurring items are changed.
", "operationId" : "onSubscription_changedWebhook", "requestBody" : { "description" : "Payload for subscription_changed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionChangedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_failed" : { "description" : "Triggered when the payment collection fails.
", "post" : { "summary" : "Triggered when the payment collection fails.", "description" : "Triggered when the payment collection fails.
", "operationId" : "onPayment_failedWebhook", "requestBody" : { "description" : "Payload for payment_failed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentFailedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "credit_note_deleted" : { "description" : "Triggered when a credit note is deleted.
", "post" : { "summary" : "Triggered when a credit note is deleted.", "description" : "Triggered when a credit note is deleted.
", "operationId" : "onCredit_note_deletedWebhook", "requestBody" : { "description" : "Payload for credit_note_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreditNoteDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "tax_withheld_refunded" : { "description" : "Triggered when a tax withheld is refunded.
", "post" : { "summary" : "Triggered when a tax withheld is refunded.", "description" : "Triggered when a tax withheld is refunded.
", "operationId" : "onTax_withheld_refundedWebhook", "requestBody" : { "description" : "Payload for tax_withheld_refunded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxWithheldRefundedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "contract_term_completed" : { "description" : "Triggered when contract term is completed.
", "post" : { "summary" : "Triggered when contract term is completed.", "description" : "Triggered when contract term is completed.
", "operationId" : "onContract_term_completedWebhook", "requestBody" : { "description" : "Payload for contract_term_completed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractTermCompletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_schedules_updated" : { "post" : { "summary" : "Event triggered when payment schedules are updated.", "operationId" : "onPayment_schedules_updatedWebhook", "requestBody" : { "description" : "Payload for payment_schedules_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSchedulesUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_expired" : { "description" : "Triggered when an omnichannel subscription item is expired.
", "post" : { "summary" : "Triggered when an omnichannel subscription item expires", "description" : "Triggered when an omnichannel subscription item is expired.
", "operationId" : "onOmnichannel_subscription_item_expiredWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "card_updated" : { "description" : "Triggered when the card is updated for a customer.
", "post" : { "summary" : "Triggered when the card is updated for a customer.", "description" : "Triggered when the card is updated for a customer.
", "operationId" : "onCard_updatedWebhook", "requestBody" : { "description" : "Payload for card_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CardUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "customer_created" : { "description" : "Triggered when a customer is created.
", "post" : { "summary" : "Triggered when a customer is created.", "description" : "Triggered when a customer is created.
", "operationId" : "onCustomer_createdWebhook", "requestBody" : { "description" : "Payload for customer_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_renewal_reminder" : { "description" : "Triggered 3 days before each subscription's renewal.
", "post" : { "summary" : "Triggered 3 days before each subscription's renewal.", "description" : "Triggered 3 days before each subscription's renewal.
", "operationId" : "onSubscription_renewal_reminderWebhook", "requestBody" : { "description" : "Payload for subscription_renewal_reminder event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionRenewalReminderEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "netd_payment_due_reminder" : { "post" : { "summary" : "Sent when a invoice's due period is about to end", "operationId" : "onNetd_payment_due_reminderWebhook", "requestBody" : { "description" : "Payload for netd_payment_due_reminder event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NetdPaymentDueReminderEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : true } }, "payment_due_reminder" : { "post" : { "summary" : "Triggered when an invoice in payment_due or not_paid [status](https://apidocs.chargebee.com/docs/api/invoices/invoice-object#status) remains unpaid for a configured number of days after its due date.", "operationId" : "onPayment_due_reminderWebhook", "requestBody" : { "description" : "Payload for payment_due_reminder event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentDueReminderEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_delivered" : { "description" : "Triggered when an order is delivered.
", "post" : { "summary" : "Triggered when an order is delivered.", "description" : "Triggered when an order is delivered.
", "operationId" : "onOrder_deliveredWebhook", "requestBody" : { "description" : "Payload for order_delivered event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderDeliveredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_cancellation_scheduled" : { "description" : "Triggered when an omnichannel subscription item is scheduled for cancellation.
", "post" : { "summary" : "Triggered when an omnichannel subscription item is scheduled for cancellation", "description" : "Triggered when an omnichannel subscription item is scheduled for cancellation.
", "operationId" : "onOmnichannel_subscription_item_cancellation_scheduledWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_cancellation_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemCancellationScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_grace_period_expired" : { "description" : "Triggered when an omnichannel subscription item's grace period has expired.
", "post" : { "summary" : "Triggered when an omnichannel subscription item's grace period has expired", "description" : "Triggered when an omnichannel subscription item's grace period has expired.
", "operationId" : "onOmnichannel_subscription_item_grace_period_expiredWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_grace_period_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemGracePeriodExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_codes_added" : { "description" : "Triggered when coupon codes are added in coupon set.
", "post" : { "summary" : "Triggered when coupon codes are added in coupon set.", "description" : "Triggered when coupon codes are added in coupon set.
", "operationId" : "onCoupon_codes_addedWebhook", "requestBody" : { "description" : "Payload for coupon_codes_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponCodesAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_cancelled" : { "description" : "Triggered when gift is cancelled.
", "post" : { "summary" : "Triggered when gift is cancelled.", "description" : "Triggered when gift is cancelled.
", "operationId" : "onGift_cancelledWebhook", "requestBody" : { "description" : "Payload for gift_cancelled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCancelledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_cancelled" : { "description" : "Triggered when an order is cancelled.
", "post" : { "summary" : "Triggered when an order is cancelled.", "description" : "Triggered when an order is cancelled.
", "operationId" : "onOrder_cancelledWebhook", "requestBody" : { "description" : "Payload for order_cancelled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderCancelledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_deleted" : { "description" : "Triggered when a coupon is deleted.
", "post" : { "summary" : "Triggered when a coupon is deleted.", "description" : "Triggered when a coupon is deleted.
", "operationId" : "onCoupon_deletedWebhook", "requestBody" : { "description" : "Payload for coupon_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_scheduled_changes_removed" : { "description" : "Triggered when scheduled change for the subscription is removed.
", "post" : { "summary" : "Triggered when scheduled change for the subscription is removed.", "description" : "Triggered when scheduled change for the subscription is removed.
", "operationId" : "onSubscription_scheduled_changes_removedWebhook", "requestBody" : { "description" : "Payload for subscription_scheduled_changes_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionScheduledChangesRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "pending_invoice_created" : { "description" : "Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled.
", "post" : { "summary" : "Event triggered (in the case of metered billing) when a \"Pending\" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the “Notify for Pending Invoices” option is enabled.", "description" : "Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled.
", "operationId" : "onPending_invoice_createdWebhook", "requestBody" : { "description" : "Payload for pending_invoice_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PendingInvoiceCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "product_deleted" : { "post" : { "summary" : "Triggered when a product resource is deleted successfully", "operationId" : "onProduct_deletedWebhook", "requestBody" : { "description" : "Payload for product_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : true } }, "entitlement_overrides_auto_removed" : { "description" : "When a limited period entitlement_override expires, it is no longer returned. No event is immediately triggered for it. However, after expiry, the entitlement_override record gets deleted within 12 hours, triggering the entitlement_overrides_auto_removed event. Therefore, this event can be considered a delayed notification for one or more entitlement_overrides having expired.
When a limited period entitlement_override expires, it is no longer returned. No event is immediately triggered for it. However, after expiry, the entitlement_override record gets deleted within 12 hours, triggering the entitlement_overrides_auto_removed event. Therefore, this event can be considered a delayed notification for one or more entitlement_overrides having expired.
Triggered when an omnichannel subscription item is upgraded.
", "post" : { "summary" : "Triggered when an omnichannel subscription item is upgraded", "description" : "Triggered when an omnichannel subscription item is upgraded.
", "operationId" : "onOmnichannel_subscription_item_upgradedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_upgraded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemUpgradedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_business_entity_changed" : { "post" : { "summary" : "Triggered when a subscription's business entity is changed", "operationId" : "onSubscription_business_entity_changedWebhook", "requestBody" : { "description" : "Payload for subscription_business_entity_changed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionBusinessEntityChangedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_one_time_order_created" : { "post" : { "summary" : "Triggered when an omnichannel one time order is created", "operationId" : "onOmnichannel_one_time_order_createdWebhook", "requestBody" : { "description" : "Payload for omnichannel_one_time_order_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelOneTimeOrderCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_source_deleted" : { "description" : "Triggered when a payment source is deleted.
", "post" : { "summary" : "Triggered when a payment source is deleted.", "description" : "Triggered when a payment source is deleted.
", "operationId" : "onPayment_source_deletedWebhook", "requestBody" : { "description" : "Payload for payment_source_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSourceDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_cancelled" : { "description" : "Triggered when an omnichannel subscription item is cancelled.
", "post" : { "summary" : "Triggered when an omnichannel subscription item is cancelled", "description" : "Triggered when an omnichannel subscription item is cancelled.
", "operationId" : "onOmnichannel_subscription_item_cancelledWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_cancelled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemCancelledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "quote_deleted" : { "description" : "Event triggered when a new quote is deleted.
", "post" : { "summary" : "Event triggered when a new quote is deleted.", "description" : "Event triggered when a new quote is deleted.
", "operationId" : "onQuote_deletedWebhook", "requestBody" : { "description" : "Payload for quote_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuoteDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "invoice_updated" : { "description" : "Triggered when you make the following changes to a pending invoice - add a charge, add a non-recurring addon, or delete a line item.
", "post" : { "summary" : "Triggered when you make the following changes to a pending invoice - add a charge, add a non-recurring addon, or delete a line item.", "description" : "Triggered when you make the following changes to a pending invoice - add a charge, add a non-recurring addon, or delete a line item.
", "operationId" : "onInvoice_updatedWebhook", "requestBody" : { "description" : "Payload for invoice_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_advance_invoice_schedule_removed" : { "description" : "Triggered when scheduled advance invoice is removed for a subscription.
", "post" : { "summary" : "Triggered when scheduled advance invoice is removed for a subscription.", "description" : "Triggered when scheduled advance invoice is removed for a subscription.
", "operationId" : "onSubscription_advance_invoice_schedule_removedWebhook", "requestBody" : { "description" : "Payload for subscription_advance_invoice_schedule_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionAdvanceInvoiceScheduleRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "card_deleted" : { "description" : "Triggered when a card is deleted for a customer.
", "post" : { "summary" : "Triggered when a card is deleted for a customer.", "description" : "Triggered when a card is deleted for a customer.
", "operationId" : "onCard_deletedWebhook", "requestBody" : { "description" : "Payload for card_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CardDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_ready_to_ship" : { "description" : "Triggered when an order reaches it's shipping date.
", "post" : { "summary" : "Triggered when an order reaches it's shipping date.", "description" : "Triggered when an order reaches it's shipping date.
", "operationId" : "onOrder_ready_to_shipWebhook", "requestBody" : { "description" : "Payload for order_ready_to_ship event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderReadyToShipEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "variant_updated" : { "post" : { "summary" : "Triggered when a product variant resource is updated successfully", "operationId" : "onVariant_updatedWebhook", "requestBody" : { "description" : "Payload for variant_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VariantUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : true } }, "subscription_moved_out" : { "description" : "Triggered when the subscription is moving out from one customer to another asynchronously.
", "post" : { "summary" : "Triggered when a subscription moved to other customer", "description" : "Triggered when the subscription is moving out from one customer to another asynchronously.
", "operationId" : "onSubscription_moved_outWebhook", "requestBody" : { "description" : "Payload for subscription_moved_out event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionMovedOutEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_schedule_scheme_created" : { "post" : { "summary" : "Event triggered when a new payment schedule scheme is created", "operationId" : "onPayment_schedule_scheme_createdWebhook", "requestBody" : { "description" : "Payload for payment_schedule_scheme_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentScheduleSchemeCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "business_entity_updated" : { "description" : "Triggered when a business entity is changed
", "post" : { "summary" : "Triggered when a business entity is changed", "description" : "Triggered when a business entity is changed
", "operationId" : "onBusiness_entity_updatedWebhook", "requestBody" : { "description" : "Payload for business_entity_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BusinessEntityUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_scheduled_resumption_removed" : { "description" : "Triggered when scheduled resumption is removed for the subscription.
", "post" : { "summary" : "Triggered when scheduled resumption is removed for the subscription.", "description" : "Triggered when scheduled resumption is removed for the subscription.
", "operationId" : "onSubscription_scheduled_resumption_removedWebhook", "requestBody" : { "description" : "Payload for subscription_scheduled_resumption_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionScheduledResumptionRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_initiated" : { "description" : "Triggered when a payment is initiated using the direct_debit payment method, or when a transaction enters the in_progress status due to asynchronous processing at the payment gateway.
Triggered when a payment is initiated using the direct_debit payment method, or when a transaction enters the in_progress status due to asynchronous processing at the payment gateway.
Triggered when a feature status transitions to archived.
Triggered when a feature status transitions to archived.
Triggered when the subscription is moved from cancelled status to active or in_trial, while reactivate_from is set to a value in the past.
Triggered when the subscription is moved from cancelled status to active or in_trial, while reactivate_from is set to a value in the past.
Triggered when an omnichannel subscription is imported.
", "post" : { "summary" : "Triggered when an omnichannel subscription is imported", "description" : "Triggered when an omnichannel subscription is imported.
", "operationId" : "onOmnichannel_subscription_importedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_imported event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionImportedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "token_expired" : { "description" : "Triggered when a nonce is expired.
", "post" : { "summary" : "Triggered when a nonce is expired.", "description" : "Triggered when a nonce is expired.
", "operationId" : "onToken_expiredWebhook", "requestBody" : { "description" : "Payload for token_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TokenExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "card_added" : { "description" : "Triggered when a card is added for a customer.
", "post" : { "summary" : "Triggered when a card is added for a customer.", "description" : "Triggered when a card is added for a customer.
", "operationId" : "onCard_addedWebhook", "requestBody" : { "description" : "Payload for card_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CardAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_created" : { "description" : "Triggered when a coupon is created.
", "post" : { "summary" : "Triggered when a coupon is created.", "description" : "Triggered when a coupon is created.
", "operationId" : "onCoupon_createdWebhook", "requestBody" : { "description" : "Payload for coupon_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "rule_deleted" : { "post" : { "summary" : "Triggered when a rule is deleted", "operationId" : "onRule_deletedWebhook", "requestBody" : { "description" : "Payload for rule_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RuleDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "item_price_entitlements_updated" : { "description" : "One or more entitlements were added or updated for an item_price.
One or more entitlements were added or updated for an item_price.
Triggered when an item price is deleted.
", "post" : { "summary" : "Triggered when an item price is deleted.", "description" : "Triggered when an item price is deleted.
", "operationId" : "onItem_price_deletedWebhook", "requestBody" : { "description" : "Payload for item_price_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemPriceDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "virtual_bank_account_deleted" : { "description" : "Triggered when a virtual bank account is deleted.
", "post" : { "summary" : "Triggered when a virtual bank account is deleted.", "description" : "Triggered when a virtual bank account is deleted.
", "operationId" : "onVirtual_bank_account_deletedWebhook", "requestBody" : { "description" : "Payload for virtual_bank_account_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VirtualBankAccountDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_schedule_scheme_deleted" : { "post" : { "summary" : "Event triggered when a payment schedule scheme is deleted", "operationId" : "onPayment_schedule_scheme_deletedWebhook", "requestBody" : { "description" : "Payload for payment_schedule_scheme_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentScheduleSchemeDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_created" : { "description" : "Triggered when a new subscription is created.
", "post" : { "summary" : "Triggered when a new subscription is created.", "description" : "Triggered when a new subscription is created.
", "operationId" : "onSubscription_createdWebhook", "requestBody" : { "description" : "Payload for subscription_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_entitlements_created" : { "description" : "Triggered on subscription creation, alongside the subscription_created event whenever the subscription has subscription_entitlements. The event payload contains the first 100 subscription_entitlements. The has_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the "List subscription entitlements" endpoint, passing the offset parameter as 1.
", "post" : { "summary" : "Triggered on subscription creation, alongside the subscription_created event whenever the subscription has subscription_entitlements. The event payload contains the first 100 subscription_entitlements. The has_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the “List subscription entitlements” endpoint, passing the offset parameter as 1.", "description" : "Triggered on subscription creation, alongside the subscription_created event whenever the subscription has subscription_entitlements. The event payload contains the first 100 subscription_entitlements. The has_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the "List subscription entitlements" endpoint, passing the offset parameter as 1.
", "operationId" : "onSubscription_entitlements_createdWebhook", "requestBody" : { "description" : "Payload for subscription_entitlements_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionEntitlementsCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_returned" : { "description" : "Triggered when an order is returned.
", "post" : { "summary" : "Triggered when an order is returned.", "description" : "Triggered when an order is returned.
", "operationId" : "onOrder_returnedWebhook", "requestBody" : { "description" : "Payload for order_returned event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderReturnedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_deleted" : { "description" : "Triggered when a subscription is deleted.
", "post" : { "summary" : "Triggered when a subscription is deleted.", "description" : "Triggered when a subscription is deleted.
", "operationId" : "onSubscription_deletedWebhook", "requestBody" : { "description" : "Payload for subscription_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_source_added" : { "description" : "Triggered when a payment source is added.
", "post" : { "summary" : "Triggered when a payment source is added.", "description" : "Triggered when a payment source is added.
", "operationId" : "onPayment_source_addedWebhook", "requestBody" : { "description" : "Payload for payment_source_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSourceAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_moved_in" : { "description" : "Triggered when the subscription is moving in from one customer to another asynchronously.
", "post" : { "summary" : "Triggered when a subscription moved from other customer", "description" : "Triggered when the subscription is moving in from one customer to another asynchronously.
", "operationId" : "onSubscription_moved_inWebhook", "requestBody" : { "description" : "Payload for subscription_moved_in event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionMovedInEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "item_price_created" : { "description" : "Triggered when an item price is created.
", "post" : { "summary" : "Triggered when an item price is created.", "description" : "Triggered when an item price is created.
", "operationId" : "onItem_price_createdWebhook", "requestBody" : { "description" : "Payload for item_price_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemPriceCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_scheduled_cancellation_removed" : { "description" : "Triggered when scheduled cancellation is removed for the subscription.
", "post" : { "summary" : "Triggered when scheduled cancellation is removed for the subscription.", "description" : "Triggered when scheduled cancellation is removed for the subscription.
", "operationId" : "onSubscription_scheduled_cancellation_removedWebhook", "requestBody" : { "description" : "Payload for subscription_scheduled_cancellation_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionScheduledCancellationRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_refunded" : { "description" : "Triggered when a payment refund is made.
", "post" : { "summary" : "Triggered when a payment refund is made.", "description" : "Triggered when a payment refund is made.
", "operationId" : "onPayment_refundedWebhook", "requestBody" : { "description" : "Payload for payment_refunded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentRefundedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "usage_file_ingested" : { "post" : { "summary" : "Triggered when a usage file is ingested", "operationId" : "onUsage_file_ingestedWebhook", "requestBody" : { "description" : "Payload for usage_file_ingested event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsageFileIngestedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "product_created" : { "post" : { "summary" : "Triggered when a product resource is created successfully", "operationId" : "onProduct_createdWebhook", "requestBody" : { "description" : "Payload for product_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : true } }, "omnichannel_subscription_moved_in" : { "description" : "Triggered when an omnichannel subscription is moved to another customer
", "post" : { "summary" : "Triggered when an omnichannel subscription is moved to another customer", "description" : "Triggered when an omnichannel subscription is moved to another customer
", "operationId" : "onOmnichannel_subscription_moved_inWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_moved_in event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionMovedInEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "differential_price_created" : { "description" : "Triggered when a differential price is created.
", "post" : { "summary" : "Triggered when a differential price is created.", "description" : "Triggered when a differential price is created.
", "operationId" : "onDifferential_price_createdWebhook", "requestBody" : { "description" : "Payload for differential_price_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DifferentialPriceCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "transaction_created" : { "description" : "Triggered when a transaction is recorded.
", "post" : { "summary" : "Triggered when a transaction is recorded.", "description" : "Triggered when a transaction is recorded.
", "operationId" : "onTransaction_createdWebhook", "requestBody" : { "description" : "Payload for transaction_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_downgrade_scheduled" : { "post" : { "summary" : "Triggered when an omnichannel subscription item downgrade is scheduled", "operationId" : "onOmnichannel_subscription_item_downgrade_scheduledWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_downgrade_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemDowngradeScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : true } }, "payment_succeeded" : { "description" : "Triggered when the payment is successfully collected.
", "post" : { "summary" : "Triggered when the payment is successfully collected.", "description" : "Triggered when the payment is successfully collected.
", "operationId" : "onPayment_succeededWebhook", "requestBody" : { "description" : "Payload for payment_succeeded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSucceededEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_canceled_with_backdating" : { "description" : "Triggered when a subscription is canceled with cancel_at set to a value in the past.
", "post" : { "summary" : "Triggered when a subscription is canceled with cancel_at set to a value in the past.", "description" : "Triggered when a subscription is canceled with cancel_at set to a value in the past.
", "operationId" : "onSubscription_canceled_with_backdatingWebhook", "requestBody" : { "description" : "Payload for subscription_canceled_with_backdating event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCanceledWithBackdatingEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "unbilled_charges_voided" : { "description" : "Triggered when unbilled charges are voided
", "post" : { "summary" : "Triggered when unbilled charges are voided", "description" : "Triggered when unbilled charges are voided
", "operationId" : "onUnbilled_charges_voidedWebhook", "requestBody" : { "description" : "Payload for unbilled_charges_voided event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnbilledChargesVoidedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "quote_created" : { "description" : "Event triggered when a new quote is generated.
", "post" : { "summary" : "Event triggered when a new quote is generated.", "description" : "Event triggered when a new quote is generated.
", "operationId" : "onQuote_createdWebhook", "requestBody" : { "description" : "Payload for quote_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuoteCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_set_deleted" : { "description" : "Triggered when a coupon set is deleted.
", "post" : { "summary" : "Triggered when a coupon set is deleted.", "description" : "Triggered when a coupon set is deleted.
", "operationId" : "onCoupon_set_deletedWebhook", "requestBody" : { "description" : "Payload for coupon_set_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponSetDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "attached_item_created" : { "description" : "Triggered when an attached item is created.
", "post" : { "summary" : "Triggered when an attached item is created.", "description" : "Triggered when an attached item is created.
", "operationId" : "onAttached_item_createdWebhook", "requestBody" : { "description" : "Payload for attached_item_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttachedItemCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "sales_order_created" : { "post" : { "summary" : "Triggered when a new sales order is created.", "operationId" : "onSales_order_createdWebhook", "requestBody" : { "description" : "Payload for sales_order_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SalesOrderCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "customer_changed" : { "description" : "Triggered when customer details are changed, and the payment method role of a customer is updated.
", "post" : { "summary" : "Triggered when a customer is changed.", "description" : "Triggered when customer details are changed, and the payment method role of a customer is updated.
", "operationId" : "onCustomer_changedWebhook", "requestBody" : { "description" : "Payload for customer_changed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerChangedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_started" : { "description" : "Triggered when a 'future' subscription gets started.
", "post" : { "summary" : "Triggered when a 'future' subscription gets started.", "description" : "Triggered when a 'future' subscription gets started.
", "operationId" : "onSubscription_startedWebhook", "requestBody" : { "description" : "Payload for subscription_started event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionStartedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_activated" : { "description" : "Triggered after the subscription has been moved from "Trial" to "Active" state.
", "post" : { "summary" : "Triggered after the subscription has been moved from \"Trial\" to \"Active\" state.", "description" : "Triggered after the subscription has been moved from "Trial" to "Active" state.
", "operationId" : "onSubscription_activatedWebhook", "requestBody" : { "description" : "Payload for subscription_activated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionActivatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_source_expiring" : { "description" : "Triggered when the customer's payment source is expiring soon. Triggered 30 days before the expiry date.
", "post" : { "summary" : "Triggered when the customer's payment source is expiring soon. Triggered 30 days before the expiry date.", "description" : "Triggered when the customer's payment source is expiring soon. Triggered 30 days before the expiry date.
", "operationId" : "onPayment_source_expiringWebhook", "requestBody" : { "description" : "Payload for payment_source_expiring event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSourceExpiringEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_reactivated" : { "description" : "Triggered when the subscription is moved from cancelled status to active or in_trial.
Triggered when the subscription is moved from cancelled status to active or in_trial.
Triggered when an order is updated.
", "post" : { "summary" : "Triggered when an order is updated.", "description" : "Triggered when an order is updated.
", "operationId" : "onOrder_updatedWebhook", "requestBody" : { "description" : "Payload for order_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_scheduled_pause_removed" : { "description" : "Triggered when scheduled pause is removed for the subscription.
", "post" : { "summary" : "Triggered when scheduled pause is removed for the subscription.", "description" : "Triggered when scheduled pause is removed for the subscription.
", "operationId" : "onSubscription_scheduled_pause_removedWebhook", "requestBody" : { "description" : "Payload for subscription_scheduled_pause_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionScheduledPauseRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_cancellation_reminder" : { "description" : "Triggered 6 days prior to the scheduled cancellation date.
", "post" : { "summary" : "Triggered 6 days prior to the scheduled cancellation date.", "description" : "Triggered 6 days prior to the scheduled cancellation date.
", "operationId" : "onSubscription_cancellation_reminderWebhook", "requestBody" : { "description" : "Payload for subscription_cancellation_reminder event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCancellationReminderEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_created_with_backdating" : { "description" : "Triggered when a subscription is created and the value of subscription.started_at is in the past.
", "post" : { "summary" : "Triggered when a subscription is created and the value of subscription.started_at is in the past.", "description" : "Triggered when a subscription is created and the value of subscription.started_at is in the past.
", "operationId" : "onSubscription_created_with_backdatingWebhook", "requestBody" : { "description" : "Payload for subscription_created_with_backdating event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCreatedWithBackdatingEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_ramp_created" : { "description" : "Triggered when a ramp is created.
", "post" : { "summary" : "Triggered when a ramp is created.", "description" : "Triggered when a ramp is created.
", "operationId" : "onSubscription_ramp_createdWebhook", "requestBody" : { "description" : "Payload for subscription_ramp_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionRampCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_deleted" : { "description" : "Triggered when an order is deleted.
", "post" : { "summary" : "Triggered when an order is deleted.", "description" : "Triggered when an order is deleted.
", "operationId" : "onOrder_deletedWebhook", "requestBody" : { "description" : "Payload for order_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_pause_scheduled" : { "post" : { "summary" : "Triggered when an omnichannel subscription item is scheduled for pause.", "operationId" : "onOmnichannel_subscription_item_pause_scheduledWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_pause_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemPauseScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_updated" : { "description" : "Triggered when a gift is updated.
", "post" : { "summary" : "Triggered when a gift is updated.", "description" : "Triggered when a gift is updated.
", "operationId" : "onGift_updatedWebhook", "requestBody" : { "description" : "Payload for gift_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_trial_extended" : { "description" : "Trial Extension
", "post" : { "summary" : "Trial Extension", "description" : "Trial Extension
", "operationId" : "onSubscription_trial_extendedWebhook", "requestBody" : { "description" : "Payload for subscription_trial_extended event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionTrialExtendedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_grace_period_started" : { "description" : "Triggered when an omnichannel subscription item has entered a grace period.
", "post" : { "summary" : "Triggered when an omnichannel subscription item's grace period has started", "description" : "Triggered when an omnichannel subscription item has entered a grace period.
", "operationId" : "onOmnichannel_subscription_item_grace_period_startedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_grace_period_started event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemGracePeriodStartedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "card_expiry_reminder" : { "description" : "Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.
", "post" : { "summary" : "Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.", "description" : "Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.
", "operationId" : "onCard_expiry_reminderWebhook", "requestBody" : { "description" : "Payload for card_expiry_reminder event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CardExpiryReminderEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "token_created" : { "description" : "Triggered when a nonce is created.
", "post" : { "summary" : "Triggered when a nonce is created.", "description" : "Triggered when a nonce is created.
", "operationId" : "onToken_createdWebhook", "requestBody" : { "description" : "Payload for token_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TokenCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "promotional_credits_added" : { "description" : "Triggered when promotional credit is added.
", "post" : { "summary" : "Triggered when promotional credit is added.", "description" : "Triggered when promotional credit is added.
", "operationId" : "onPromotional_credits_addedWebhook", "requestBody" : { "description" : "Payload for promotional_credits_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PromotionalCreditsAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_ramp_updated" : { "description" : "Triggered when a ramp is updated.
", "post" : { "summary" : "Triggered when a subscription ramp is updated.", "description" : "Triggered when a ramp is updated.
", "operationId" : "onSubscription_ramp_updatedWebhook", "requestBody" : { "description" : "Payload for subscription_ramp_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionRampUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "customer_entitlements_updated" : { "description" : "Triggered when a customer_entitlement is updated.
Triggered when a customer_entitlement is updated.
Triggered when the payment source for a customer has expired.
", "post" : { "summary" : "Triggered when the payment source for a customer has expired.", "description" : "Triggered when the payment source for a customer has expired.
", "operationId" : "onPayment_source_expiredWebhook", "requestBody" : { "description" : "Payload for payment_source_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSourceExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "customer_moved_out" : { "description" : "Triggered when a customer is copied to another site.
", "post" : { "summary" : "Triggered when a customer is copied to another site.", "description" : "Triggered when a customer is copied to another site.
", "operationId" : "onCustomer_moved_outWebhook", "requestBody" : { "description" : "Payload for customer_moved_out event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerMovedOutEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_entitlements_updated" : { "description" : "Triggered on subscription change, alongside the subscription_changed event whenever there are updates to a subscription's entitlements resulting from modifications to its recurring and non recurring items. The event payload contains the first 100 subscription_entitlements. The has_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the "List subscription entitlements" endpoint, passing the offset parameter as 1.
", "post" : { "summary" : "Triggered on subscription update, alongside the subscription_updated event whenever the subscription has subscription_entitlements updated. The event payload contains the first 100 subscription_entitlements. The has_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the “List subscription entitlements” endpoint, passing the offset parameter as 1.", "description" : "Triggered on subscription change, alongside the subscription_changed event whenever there are updates to a subscription's entitlements resulting from modifications to its recurring and non recurring items. The event payload contains the first 100 subscription_entitlements. The has_next attribute is set to true if more than 100 subscription entitlements are available. You can retrieve the next page by calling the "List subscription entitlements" endpoint, passing the offset parameter as 1.
", "operationId" : "onSubscription_entitlements_updatedWebhook", "requestBody" : { "description" : "Payload for subscription_entitlements_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionEntitlementsUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_dunning_expired" : { "description" : "Triggered when an omnichannel subscription item's dunning period has expired.
", "post" : { "summary" : "Triggered when an omnichannel subscription item's dunning has expired", "description" : "Triggered when an omnichannel subscription item's dunning period has expired.
", "operationId" : "onOmnichannel_subscription_item_dunning_expiredWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_dunning_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemDunningExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "hierarchy_created" : { "description" : "Triggered when a hierarchy is created.
", "post" : { "summary" : "Triggered when a hierarchy is created.", "description" : "Triggered when a hierarchy is created.
", "operationId" : "onHierarchy_createdWebhook", "requestBody" : { "description" : "Payload for hierarchy_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HierarchyCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "attached_item_deleted" : { "description" : "Triggered when an attached item is deleted.
", "post" : { "summary" : "Triggered when an attached item is deleted.", "description" : "Triggered when an attached item is deleted.
", "operationId" : "onAttached_item_deletedWebhook", "requestBody" : { "description" : "Payload for attached_item_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttachedItemDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_scheduled_cancellation_removed" : { "description" : "Triggered when an omnichannel subscription item scheduled cancellation is removed.
", "post" : { "summary" : "Triggered when an omnichannel subscription item scheduled cancellation is removed", "description" : "Triggered when an omnichannel subscription item scheduled cancellation is removed.
", "operationId" : "onOmnichannel_subscription_item_scheduled_cancellation_removedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_scheduled_cancellation_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemScheduledCancellationRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "item_updated" : { "description" : "Triggered when an item is updated.
", "post" : { "summary" : "Triggered when an item is updated.", "description" : "Triggered when an item is updated.
", "operationId" : "onItem_updatedWebhook", "requestBody" : { "description" : "Payload for item_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_set_created" : { "description" : "Triggered when a coupon set is created.
", "post" : { "summary" : "Triggered when a coupon set is created.", "description" : "Triggered when a coupon set is created.
", "operationId" : "onCoupon_set_createdWebhook", "requestBody" : { "description" : "Payload for coupon_set_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponSetCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_intent_updated" : { "description" : "Triggered when a payment intent is updated.
", "post" : { "summary" : "Triggered when a payment intent is updated.", "description" : "Triggered when a payment intent is updated.
", "operationId" : "onPayment_intent_updatedWebhook", "requestBody" : { "description" : "Payload for payment_intent_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentIntentUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_resent" : { "description" : "Triggered when an order is resent.
", "post" : { "summary" : "Triggered when an order is resent.", "description" : "Triggered when an order is resent.
", "operationId" : "onOrder_resentWebhook", "requestBody" : { "description" : "Payload for order_resent event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResentEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_scheduled_downgrade_removed" : { "post" : { "summary" : "Triggered when an omnichannel subscription item scheduled downgrade is removed", "operationId" : "onOmnichannel_subscription_item_scheduled_downgrade_removedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_scheduled_downgrade_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemScheduledDowngradeRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : true } }, "omnichannel_subscription_created" : { "description" : "Triggered when an omnichannel subscription is created.
", "post" : { "summary" : "Triggered when an omnichannel subscription is created", "description" : "Triggered when an omnichannel subscription is created.
", "operationId" : "onOmnichannel_subscription_createdWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "tax_withheld_recorded" : { "description" : "Triggered when a tax withheld is recorded for an invoice.
", "post" : { "summary" : "Triggered when a tax withheld is recorded for an invoice.", "description" : "Triggered when a tax withheld is recorded for an invoice.
", "operationId" : "onTax_withheld_recordedWebhook", "requestBody" : { "description" : "Payload for tax_withheld_recorded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxWithheldRecordedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "price_variant_created" : { "description" : "Triggered when a price variant resource is created successfully
", "post" : { "summary" : "Triggered when a price variant is created.", "description" : "Triggered when a price variant resource is created successfully
", "operationId" : "onPrice_variant_createdWebhook", "requestBody" : { "description" : "Payload for price_variant_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PriceVariantCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "differential_price_deleted" : { "description" : "Triggered when a differential price is deleted.
", "post" : { "summary" : "Triggered when a differential price is deleted.", "description" : "Triggered when a differential price is deleted.
", "operationId" : "onDifferential_price_deletedWebhook", "requestBody" : { "description" : "Payload for differential_price_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DifferentialPriceDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_items_renewed" : { "description" : "Triggered when one or more subscription items are renewed.
", "post" : { "summary" : "Triggered when one or more Subscription Items are renewed", "description" : "Triggered when one or more subscription items are renewed.
", "operationId" : "onSubscription_items_renewedWebhook", "requestBody" : { "description" : "Payload for subscription_items_renewed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionItemsRenewedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "rule_created" : { "post" : { "summary" : "Triggered when a rule is created", "operationId" : "onRule_createdWebhook", "requestBody" : { "description" : "Payload for rule_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RuleCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "contract_term_cancelled" : { "description" : "Triggered when contract term is cancelled.
", "post" : { "summary" : "Triggered when contract term is cancelled.", "description" : "Triggered when contract term is cancelled.
", "operationId" : "onContract_term_cancelledWebhook", "requestBody" : { "description" : "Payload for contract_term_cancelled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractTermCancelledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "contract_term_renewed" : { "description" : "Triggered when a contract term is renewed.
", "post" : { "summary" : "Triggered when a contract term is renewed.", "description" : "Triggered when a contract term is renewed.
", "operationId" : "onContract_term_renewedWebhook", "requestBody" : { "description" : "Payload for contract_term_renewed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractTermRenewedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "invoice_deleted" : { "description" : "Event triggered when an invoice is deleted.
", "post" : { "summary" : "Event triggered when an invoice is deleted.", "description" : "Event triggered when an invoice is deleted.
", "operationId" : "onInvoice_deletedWebhook", "requestBody" : { "description" : "Payload for invoice_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "item_price_entitlements_removed" : { "description" : "One or more item_price_entitlements were removed for an item_price or a feature.
One or more item_price_entitlements were removed for an item_price or a feature.
Triggered when an omnichannel subscription item has entered a dunning period.
", "post" : { "summary" : "Triggered when an omnichannel subscription item's dunning has started", "description" : "Triggered when an omnichannel subscription item has entered a dunning period.
", "operationId" : "onOmnichannel_subscription_item_dunning_startedWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_dunning_started event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemDunningStartedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "omnichannel_subscription_item_change_scheduled" : { "description" : "Triggered when an omnichannel subscription item change is scheduled.
", "post" : { "summary" : "Triggered when an omnichannel subscription item change is scheduled", "description" : "Triggered when an omnichannel subscription item change is scheduled.
", "operationId" : "onOmnichannel_subscription_item_change_scheduledWebhook", "requestBody" : { "description" : "Payload for omnichannel_subscription_item_change_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OmnichannelSubscriptionItemChangeScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "pending_invoice_updated" : { "description" : "Triggered when you make the following changes to the invoice - void, delete, invoice address update, status change, payment changes - apply payment / remove payment, credit apply/remove, credit note creation, and so on. 'Invoice_updated' is triggered for all changes made to the invoice except for the changes which trigger 'pending_invoice_updated'.
", "post" : { "summary" : "Triggered when you make the following changes to the invoice - void, delete, invoice address update, status change, payment changes - apply payment / remove payment, credit apply/remove, credit note creation, and so on. 'Invoice_updated' is triggered for all changes made to the invoice except for the changes which trigger 'pending_invoice_updated'.", "description" : "Triggered when you make the following changes to the invoice - void, delete, invoice address update, status change, payment changes - apply payment / remove payment, credit apply/remove, credit note creation, and so on. 'Invoice_updated' is triggered for all changes made to the invoice except for the changes which trigger 'pending_invoice_updated'.
", "operationId" : "onPending_invoice_updatedWebhook", "requestBody" : { "description" : "Payload for pending_invoice_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PendingInvoiceUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "quote_updated" : { "description" : "Triggered when a quote is updated.
", "post" : { "summary" : "Triggered when a quote is updated.", "description" : "Triggered when a quote is updated.
", "operationId" : "onQuote_updatedWebhook", "requestBody" : { "description" : "Payload for quote_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuoteUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "attached_item_updated" : { "description" : "Triggered when an attached item is updated.
", "post" : { "summary" : "Triggered when an attached item is updated.", "description" : "Triggered when an attached item is updated.
", "operationId" : "onAttached_item_updatedWebhook", "requestBody" : { "description" : "Payload for attached_item_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttachedItemUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_source_updated" : { "description" : "Triggered when the payment source is updated.
", "post" : { "summary" : "Triggered when the payment source is updated and also when a role is assigned to it.", "description" : "Triggered when the payment source is updated.
", "operationId" : "onPayment_source_updatedWebhook", "requestBody" : { "description" : "Payload for payment_source_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSourceUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "business_entity_deleted" : { "description" : "Triggered when a business entity is deleted
", "post" : { "summary" : "Triggered when a business entity is deleted", "description" : "Triggered when a business entity is deleted
", "operationId" : "onBusiness_entity_deletedWebhook", "requestBody" : { "description" : "Payload for business_entity_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BusinessEntityDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "authorization_voided" : { "description" : "Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time.
", "post" : { "summary" : "Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time.", "description" : "Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time.
", "operationId" : "onAuthorization_voidedWebhook", "requestBody" : { "description" : "Payload for authorization_voided event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationVoidedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_ramp_deleted" : { "description" : "Triggered when a ramp is deleted.
", "post" : { "summary" : "Triggered when a ramp is deleted.", "description" : "Triggered when a ramp is deleted.
", "operationId" : "onSubscription_ramp_deletedWebhook", "requestBody" : { "description" : "Payload for subscription_ramp_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionRampDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } } } }