Chargebee

Chargebee API

Chargebee API endpoints from Chargebee

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Chargebee API endpoints from Chargebee

Endpoints 266

addresses

  • GETRetrieve an address/addresses?subscription_id=&label=Retrieves an address resource for a subscription and the specified label.
  • POSTUpdate an address/addressesAdds 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…

alerts

  • GETRetrieve an alert/alerts/:alert-idRetrieves a single alert configuration by alert_id. This returns the rule definition only and does not include runtime evaluation state. Note: To check…
  • POSTUpdate an alert/alerts/:alert-idUpdates an existing alert configuration. Use this to change the threshold values or toggle the status between enabled and disabled. Impacts Alert status on…
  • POSTDelete an alert/alerts/:alert-id/deleteDeletes an alert configuration. Only subscription-scoped alerts can be deleted using this endpoint. Important This operation cannot delete global alerts. To…
  • GETList alerts/alerts?limit=&offset=&id=&type=&subscription_id=&status=Returns a list of alert configurations meeting all the conditions specified in the filter parameters below. Results include both global and…
  • POSTCreate an alert/alertsCreates a new alert configuration. Depending on type, the alert can monitor usage, spend, or credit balance, and it can be global or subscription-scoped…
  • GETList alert statuses for an alert/alerts/:alert-id/alert_statuses?limit=&offset=&alarm_status=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…

attached_items

  • GETRetrieve an attached item/attached_items/:attached-item-id?parent_item_id=Retrieves details of an attached addon or a charge item.
  • POSTUpdate an attached item/attached_items/:attached-item-idUpdates an attached addon or a charge item for a plan.
  • POSTDelete an attached item/attached_items/:attached-item-id/deleteDeletes an attached addon or a charge item.

batch

  • POSTIngest usage events in batchhttps://demo.ingest.chargebee.com:443/api/v2/batch/usage_eventsThis endpoint ingests a batch of usage events into Chargebee. Note : - You can ingest 500 events in a batch ingestion. See also * Limits for Usage-based…

business_entities

  • GETRetrieve a business entity/business_entities/:business-entity-idRetrieves the business_entity resource identified by the specified unique identifier.
  • POSTUpdate business entity/business_entities/:business-entity-idUpdates the business_entity resource identified by the specified unique identifier. You can change the name and the status of the business entity.
  • GETList business entities/business_entities?limit=&offset=&include_deleted=&name=JohnReturns a list of business_entity resources configured for the site, meeting all the conditions specified in the filter parameters below. By default, this…
  • POSTCreate a business entity/business_entitiesCreates a business_entity resource for the site. Use this endpoint to set up an additional business unit or brand under your organization, each with its own…
  • GETList business entity transfers/business_entities/transfers?limit=&offset=&resource_type=customer&resource_id=9bsvnHgsvmsI&active_resource_id=8gsnbYfsMLds&created_at=1702022464&sort_by=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…
  • POSTTransfer a customer to another business entity/business_entities/transfersImportant This 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…

business_rules

  • POSTApply business rules/business_rules/apply_rulesEvaluates business rules against a context that you supply. You can evaluate a single rule using rule_id, every rule in a ruleset using ruleset_id, or an ad…
  • POSTDelete a business rule draft/business_rules/:business-rule-id/delete_draftDeletes the draft version of a business rule, permanently discarding every change that has not been released. The released version of the rule is not…
  • POSTRelease a business rule/business_rules/:business-rule-id/releaseReleases the draft version of a business rule. The draft is promoted to the next version number and becomes the released version that Chargebee evaluates, so…
  • POSTActivate a business rule/business_rules/:business-rule-id/activateActivates a business rule by setting its active attribute to true, so that Chargebee evaluates it. Every rule is created inactive, so this is the operation…
  • GETRetrieve a business rule draft/business_rules/:business-rule-id/draftRetrieves the draft version of a business rule. The draft holds changes that have not been released yet, so it can differ from the released version returned…
  • POSTUpdate a business rule draft/business_rules/:business-rule-id/draftUpdates the draft version of a business rule. The first edit creates a draft from the released version, and every later edit updates that same draft. Changes…
  • POSTDelete a business rule/business_rules/:business-rule-id/deleteDeletes a business rule and removes it from every business ruleset it belongs to. This is a soft delete: the rule is no longer returned by the API or…
  • POSTDeactivate a business rule/business_rules/:business-rule-id/deactivateDeactivates a business rule by setting its active attribute to false. The rule is retained along with its versions and ruleset memberships, but Chargebee…
  • GETRetrieve a business rule/business_rules/:business-rule-idRetrieves the released version of the business rule with the specified id, which is the version Chargebee evaluates. The response describes the version in…
  • GETList business rules/business_rules?limit=&offset=&draft=true&active=trueReturns a list of business rules satisfying all the conditions specified in the filter parameters. Each rule is returned as its released version. Deleted…
  • POSTCreate a business rule/business_rulesCreates a business rule and releases its first version, so the new rule has latest_version set to 1 and released_at set. The rule is created inactive:…

business_rulesets

  • GETRetrieve a business ruleset/business_rulesets/:business-ruleset-idRetrieves the business ruleset with the specified id. To fetch the rules it contains, use List rules in a business ruleset.
  • POSTUpdate a business ruleset/business_rulesets/:business-ruleset-idUpdates a business ruleset. Passing rules replaces the entire membership of the ruleset. To change membership incrementally, use Add business rules to a…
  • POSTRemove business rules from a ruleset/business_rulesets/:business-ruleset-id/remove_rulesRemoves one or more business rules from a ruleset without changing any of its other attributes. The rules themselves are not deleted and remain available to…
  • POSTDelete a business ruleset/business_rulesets/:business-ruleset-id/deletePermanently deletes a business ruleset. Prerequisites \& Constraints * The business ruleset must not contain any business rules. If it does, remove the…
  • POSTDeactivate a business ruleset/business_rulesets/:business-ruleset-id/deactivateDeactivates a business ruleset by setting its active attribute to false. The ruleset and its rule memberships are retained, but Chargebee stops evaluating it.…
  • GETList rules in a business ruleset/business_rulesets/:business-ruleset-id/rules?limit=&offset=&active=trueReturns the business rules that belong to a ruleset, along with the priority that determines their evaluation order. The results can be filtered by active…
  • GETList business rulesets/business_rulesets?limit=&offset=&active=trueReturns a list of business rulesets satisfying all the conditions specified in the filter parameters. The response describes each ruleset but does not carry…
  • POSTCreate a business ruleset/business_rulesetsCreates a business ruleset. A ruleset groups business rules so that they can be evaluated together, in the priority order you assign, using the strategy set…
  • POSTActivate a business ruleset/business_rulesets/:business-ruleset-id/activateActivates a business ruleset by setting its active attribute to true, so that Chargebee evaluates the rules it contains. Impacts Business ruleset The ruleset…
  • POSTAdd business rules to a ruleset/business_rulesets/:business-ruleset-id/add_rulesAdds one or more business rules to a ruleset without changing any of its other attributes. The rules are appended to the end of the ruleset's evaluation…

cards

  • GETRetrieve card for a customer/cards/:customer-idDeprecated This operation is obsoleted by the Retrieve a payment source API . Retrieves the credit card for the customer id.

collections_payment_promises

  • GETList collections payment promises/collections_payment_promises?limit=&offset=&customer_id=Azq8CVnhdtD7C1xD&invoice_id=inv_123&status=Lists collections payment promises. All filters are optional; without filters, promises are returned newest first.
  • POSTCreate a collections payment promise/collections_payment_promisesCreates a collections payment promise that records a customer's commitment to pay by promised_on. The response is a list with one promise for each covered…
  • POSTCancel a collections payment promise/collections_payment_promises/:collections-payment-promise-id/cancelCancels an active collections payment promise. Cancelling does not resume the invoice's reminder sequence. A promise can also end automatically. When the…
  • GETRetrieve a payment promise/collections_payment_promises/:collections-payment-promise-idRetrieves a collections payment promise by ID.
  • POSTUpdate a collections payment promise/collections_payment_promises/:collections-payment-promise-idUpdates an active collections payment promise. You can change promised_on, reason, or promised_by; omitted parameters remain unchanged.

comments

  • POSTDelete a comment/comments/:comment-id/deleteDelete a comment for an entity identified by comment ID. Only the comments that are added via Admin console and API can be deleted. Chargebee generated…
  • GETRetrieve a comment/comments/:comment-idRetrieve a comment for an entity identified by comment ID.
  • GETList comments/comments?limit=&offset=&entity_type=&entity_id=&created_at=1456332678&sort_by=Retrieve the list of comments sorted by the recent ones on the top. If you want to retrieve the list of comments for an entity, for example, subscription you…
  • POSTCreate a comment/commentsCreate a new comment for an entity. The newly added comment will be shown in the web interface as well.

configurations

  • GETList site configurations/configurationsReturns a list of your domain and product catalog version details.

coupon_codes

  • GETList coupon codes/coupon_codes?limit=&offset=&code=OFF2009&coupon_id=OFF20&coupon_set_name=OFF20&status=redeemedList the available coupon codes.
  • GETRetrieve a coupon code/coupon_codes/:coupon-code-codeRetrieves a specific coupon code details.
  • POSTArchive a coupon code/coupon_codes/:coupon-code-code/archiveArchives a coupon code thereby making it inactive. The archived coupon code cannot be applied to any subscription.

coupon_sets

  • GETList coupon sets/coupon_sets?limit=&offset=&id=bulk-codes-1&name=bulk-codes-1&coupon_id=OFF2008&total_count=10&redeemed_count=5&archived_count=2Use this API to get the list of all the coupon sets.
  • POSTCreate a coupon set/coupon_setsCreate a coupon set with a coupon code compatible to your product offers and promotional discounts
  • POSTUpdate a coupon set/coupon_sets/:coupon-set-id/updateUse this API to update a specific coupon set by updating its name and the meta_data.
  • GETRetrieve a coupon set/coupon_sets/:coupon-set-idUse this API to retrieve a specific coupon set.
  • POSTAdd coupon codes to coupon set/coupon_sets/:coupon-set-id/add_coupon_codesThis API add coupon codes to an existing coupon set.
  • POSTDelete unused coupon codes/coupon_sets/:coupon-set-id/delete_unused_coupon_codesUse this API to delete all the unutilised coupon codes from a specific coupon set.
  • POSTDelete a coupon set/coupon_sets/:coupon-set-id/deleteUse this endpoint to delete a specific coupon set

coupons

  • GETList coupons/coupons?limit=&offset=&id=OFF2008&name=Offer 10&discount_type=fixed_amount&duration_type=forever&status=active&apply_on=invoice_amount&created_at=145222875&updated_at=1243545465&sort_by=&currency_code=USD&applicable_item_price_ids=day-pass-USDList 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,…
  • POSTUpdate a coupon for items/coupons/:coupon-id/update_for_itemsThis API updates a coupon that is created for a specific promotion or offers.
  • POSTUnarchive a coupon/coupons/:coupon-id/unarchiveThis API unarchives a specific coupon using the coupon ID.
  • POSTDelete a coupon/coupons/:coupon-id/deleteIf no Subscriptions/Invoices are linked to this Coupon, the Coupon will be deleted from your Chargebee site. This action cannot be undone. To ensure that…
  • POSTCopy a coupon/coupons/copyCopies 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…
  • GETRetrieve a coupon/coupons/:coupon-idThis API retrieves a specific coupon using the coupon ID.
  • POSTCreate a coupon for items/coupons/create_for_itemsThis API creates a new coupon for a specific promotion or offers.

credit_notes

  • POSTRecord refund for a credit note/credit_notes/:credit-note-id/record_refundRecords 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…
  • POSTImport credit note/credit_notes/import_credit_noteImports a credit note into Chargebee Billing. This endpoint allows you to import a credit note from external systems, such as accounting software, into…
  • POSTDelete a credit note/credit_notes/:credit-note-id/deleteThis API deletes a credit note. A credit note once deleted, is deleted permanently. You cannot delete a credit which has already been deleted or refunded. If…
  • POSTRetrieve credit note as PDF/credit_notes/:credit-note-id/pdfGets the credit note as PDF. The returned URL is secure and allows download. The URL will expire in 60 minutes.
  • POSTSend an einvoice for credit notes/credit_notes/:credit-note-id/send_einvoiceThis endpoint is used to send an e-invoice for invoice. To support cases like TDS and invoice edits, we need to stop auto e-invoice sending and be able to…
  • POSTVoid a credit note/credit_notes/:credit-note-id/voidVoid or invalidate the specified credit note. Use this operation for incorrectly generated credit notes, such as those with wrong details or created by…
  • POSTRefund a credit note/credit_notes/:credit-note-id/refundRefunds a specified amount from a refundable credit note back to the customer's payment source. This operation supports only refunds against online payments.…
  • GETList credit notes/credit_notes?limit=&offset=&include_deleted=&id=CN_123&customer_id=4gmiXbsjdm&subscription_id=4gmiXbsjdm&reference_invoice_id=INVOICE_876&type=adjustment&reason_code=waiver&create_reason_code=Other&status=adjusted&date=1435054328&total=1200&price_type=tax_exclusive&amount_allocated=1200&amount_refunded=130&amount_available=1400&voided_at=1435054328&updated_at=1243545465&sort_by=&channel=APP STORE&einvoice=Lists all the Credit Notes.
  • POSTCreate credit note/credit_notesCreates a credit note for the specified invoice. Impacts Invoice See Impact on reference invoice. Credit note * A new credit note of the specified type is…
  • POSTUpdate Credit Note Details/credit_notes/:credit-note-id/updateUpdates the custom fields and comment of a credit note. Use this operation to add or change custom field values, or to attach an internal comment, without…
  • GETDownload e-invoice for credit note/credit_notes/:credit-note-id/download_einvoiceDownload 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…
  • POSTResend failed einvoice in credit notes/credit_notes/:credit-note-id/resend_einvoiceResend failed einvoice in credit notes.
  • POSTRemove tax withheld refunds from a credit note/credit_notes/:credit-note-id/remove_tax_withheld_refundRemoves a linked_tax_withheld_refunds record from the credit_note .
  • GETRetrieve a credit note/credit_notes/:credit-note-id?line_items_limit=&line_items_offset=Retrieves the Credit Note identified by the specified Credit Note number.
  • POSTSend Credit Note Email/credit_notes/:credit-note-id/send_emailSends the credit note email to the customer using the site's published Send Credit Note Email Engage notification template. Use this operation to resend or…

credit_units

  • GETList credit units/credit_units?limit=&offset=&status=active&id=ai-tokensRetrieves a paginated list of credit units meeting all the conditions specified in the filter parameters.
  • POSTCreate a credit unit/credit_unitsCreates a new credit unit in the active status.
  • POSTArchive a credit unit/credit_units/:credit-unit-id/archive_commandArchives an active credit unit. Once archived, the credit unit can no longer be used to create grant configurations for items and grant configuration…
  • POSTUpdate a credit unit/credit_units/:credit-unit-idUpdates an existing credit unit.
  • POSTReactivate a credit unit/credit_units/:credit-unit-id/reactivate_commandReactivates an archived credit unit. Once reactivated, the credit unit can be used to configure grants for plans, add-ons, and charges, as well as grant…

csv_tax_rules

  • POSTTaxes Csv import/csv_tax_rules

currencies

  • POSTAdd schedule/currencies/:site-currency-id/add_scheduleThis API is used to schedule exchange rate modification for a manual forex_type currency.
  • POSTAdd a new currency/currenciesThis API is used to add a new currency to your Chargebee site. Prior to using this API, ensure that the multi-currency feature is enabled. If the forex_type…
  • GETRetrieve a currency/currencies/:site-currency-idThis API is used to retrieve an individual currency object configured within this site.
  • POSTUpdate a currency/currencies/:site-currency-idThis API is used to update the configured currencies within your Chargebee site. Additionally, If the forex_type is set to manual , you can specify the…
  • POSTRemove schedule/currencies/:site-currency-id/remove_scheduleThis API allows you to remove a scheduled exchange rate from a currency.
  • GETList currencies/currencies/list?limit=&offset=This API is used to retrieve the list of all currencies currently configured within the site.

custom_field_configs

  • GETRetrieve a custom field configuration/custom_field_configs/retrieve?entity_type=&api_name=Retrieves the configuration for the custom field that matches the specified entity type and API name.
  • GETList custom field configurations/custom_field_configs?limit=&offset=&entity_type=Lists the configurations for all custom fields defined for the specified entity type.

customers

  • POSTImport a subscription/customers/:customer-id/import_for_itemsImports a subscription for an existing customer. Use this operation when migrating subscriptions from another billing system. Prerequisites \& Constraints If…
  • POSTCreate a subscription/customers/:customer-id/subscription_for_itemsNote: This endpoint optionally supports 3DS. To use it create a payment_intent and provide it via this endpoint. Creates a new subscription for an existing…
  • POSTLink a customer to an account hierarchy/customers/:customer-id/relationshipsCreates a hierarchical relationship between two customers. The path parameter customer_id identifies the child in this relationship, and parent_id identifies…
  • POSTUnlink a customer from its parent account/customers/:customer-id/delete_relationshipWhen a customer belongs to an account hierarchy , this operation detaches the customer from its parent. The hierarchy, if any, beneath the customer remains…
  • POSTDelete contacts for a customer/customers/:customer-id/delete_contactDeletes a particular contact for a customer. You can delete a contact by giving the Contact ID as the input parameter.
  • POSTAssign payment role/customers/:customer-id/assign_payment_roleAssign or unassign the primary or backup payment role for a payment source. Set role when creating a payment source You can also assign a payment source as…
  • POSTMove a customer/customers/moveThis 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…
  • POSTUpdate payment method for a customer/customers/:customer-id/update_payment_methodPayment Sources comes with additional options and improvements to the Card APIs . For this operation, use the Create using temporary token API or Create using…
  • GETList customers/customers?limit=&offset=&include_deleted=&id=9bsvnHgsvmsI&first_name=John&last_name=Clint&email=john@test.com&company=Globex Corp&phone=(541) 754-3010&auto_collection=on&taxability=taxable&created_at=1435054328&updated_at=1243545465&offline_payment_method=cash&auto_close_invoices=true&channel=APP STORE&business_entity_id=business_entity_id&sort_by=&relationship=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.
  • POSTCreate a customer/customersCreates a customer resource. Optionally, creates a payment source for the customer. Creating payment source Although this operation supports creation of a…
  • GETList of contacts for a customer/customers/:customer-id/contacts?limit=&offset=This API retrieves all the contacts for a customer.
  • POSTClear personal data of a customer/customers/:customer-id/clear_personal_dataClear personal details of a customer using this API.
  • POSTRecord an excess payment for a customer/customers/:customer-id/record_excess_paymentRecords an offline payment for a customer and adds it to the customer's excess payments balance. Impacts Invoices * Chargebee automatically applies excess…
  • POSTSend Payment Request Email/customers/:customer-id/send_payment_requestSends a request payment email to the customer using the site's published Collect Payment Email Engage notification template. Use this operation to manually…
  • POSTUpdate account hierarchy access settings for a customer/customers/:customer-id/update_hierarchy_settingsWhen 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…
  • POSTUpdate billing info for a customer/customers/:customer-id/update_billing_infoUpdates a customer's billing information, including billing address and tax-related details such as VAT number. Note See Related APIs for other customer…
  • POSTDelete a customer/customers/:customer-id/deleteDeletes a specified customer. This operation schedules the customer resource for deletion, and it is permanently deleted after a few minutes. If you wish to…
  • GETGet account hierarchy for a customer/customers/:customer-id/hierarchy?hierarchy_operation_type=Retrieves the full or partial account hierarchy for a customer.
  • GETRetrieve a customer/customers/:customer-idRetrieves the details of the desired customer. You can use the unique identifier for a particular customer to retrieve the desired details.
  • POSTUpdate a customer/customers/:customer-idUpdates the details of the specified customer. Use this API to modify customer information, including standard attributes and any configured custom…
  • GETGet paginated account hierarchy for a customer/customers/:customer-id/hierarchy_detail?limit=&offset=&hierarchy_operation_type=Retrieves the account hierarchy tree for the customer.
  • POSTChange billing date/customers/:customer-id/change_billing_dateApplicable when *calendar billing* (with customer specific billing date support) is enabled. Changes the customer's *billing_date* and/or…
  • POSTAdd contacts to a customer/customers/:customer-id/add_contactAdd a contact to a customer resource. Prerequisites \& Constraints * The customer must have fewer than 10 contacts already added. Impacts Email notifications…
  • POSTMerge customers/customers/mergeThis API moves a customer's payment methods, subscriptions, invoices, credit notes, transactions, unbilled charges, and orders to another customer. Events and…
  • POSTCollect payment for customer/customers/:customer-id/collect_paymentNote: This operation optionally supports 3DS verification flow. To achieve the same, create the Payment Intent and pass it as input parameter to this API.…
  • POSTUpdate contacts for a customer/customers/:customer-id/update_contactUpdates 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.
  • POSTCopy card/customers/:customer-id/copy_carddeprecated The Payment Sources API , with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the Export payment…
  • POSTSwitch gateway/customers/:customer-id/switch_gatewayDeprecated This request is obsoleted by the Switch gateway account API for Payment Sources. Switches the gateway in which customer's card information is…
  • POSTDelete card for a customer/customers/:customer-id/delete_carddeprecated The Payment Sources API , with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the Delete a payment…
  • POSTUpdate card for a customer/customers/:customer-id/credit_cardDeprecated The Payment Sources API , with its additional options and improvements, obsoletes the Cards APIs . This operation is obsoleted by the following: *…
  • GETList email logs for a customer/customers/:customer-id/email_logs?limit=&offset=&sent_on=1435054328&business_entity_id=business_entity_id&brand_id=brand_idRetrieves the emails sent for a customer, newest first. Use this operation to inspect delivery status, recipient, and template for emails Chargebee sent to a…
  • GETUpcoming invoices estimate/customers/:customer-id/upcoming_invoices_estimate?include_usage_charges=Estimate of the upcoming scheduled invoices (subscription activations, renewals etc) of a customer. For now preview of the invoices generated on the immediate…
  • POSTEstimate for creating a subscription/customers/:customer-id/create_subscription_for_items_estimateGenerates an estimate without creating a subscription. This endpoint can be called when you want to preview details of a new subscription before actually…
  • POSTCreate a quote for subscription creation/customers/:customer-id/create_subscription_quote_for_itemsCreate a quote for new subscription line items of a customer.
  • GETList customer entitlements/customers/:customer-id/customer_entitlements?limit=&offset=&consolidate_entitlements=Tip To retrieve subscription entitlements for a specific subscription, use the List subscription entitlements API. Returns a list of customer_entitlement…
  • GETList vouchers for a customer/customers/:customer-id/payment_vouchers?limit=&offset=&status=active, consumed, expired&sort_by=Retrieves vouchers for a customer in reverse chronological order.

differential_prices

  • POSTDelete a differential price/differential_prices/:differential-price-id/deleteDelete a differential price using a differential_price_id and item_price_id .
  • GETList differential prices/differential_prices?limit=&offset=&item_price_id=day-pass-USD&item_id=day-pass&id=defcc4f1-f21f-47f4-8019-beddb9beab5f&parent_item_id=basicReturns 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…
  • GETRetrieve a differential price/differential_prices/:differential-price-id?item_price_id=Retrieve a differential price using a differential_price_id and item_price_id .
  • POSTUpdate a differential price/differential_prices/:differential-price-idUpdate a differential price using a differential_price_id and item_price_id .

disputes

  • GETRetrieve A Dispute/disputes/:dispute-idRetrieves a dispute identified by its unique id. Use this operation to check the current status of a dispute, the amount under dispute, and the transaction…
  • GETList Disputes/disputes?limit=&offset=&id=dspt_16BdDXSlbu4uV1Ee6&status=initiated&type=chargeback&customer_id=4gmiXbsjdm&transaction_id=txn_16BdDXSlbu4uV1Ee6&amount=1200&created_at=1435054328Lists the disputes raised against the transactions on your site, with the most recently created dispute first. Use the filter parameters to narrow the list to…

einvoices

  • GETList e-invoices/einvoices?limit=&offset=&id=HmaT0avT2mtbTL3mR&reference_id=einvoice_ref_123&updated_at=1243545465&sort_by=&invoice_id=&credit_note_id=Returns a list of e-invoices. You can filter by id, reference id, updated at, invoice id, or credit note id.
  • GETRetrieve an e-invoice/einvoices/:einvoice-idRetrieve the e-invoice for the specified e-invoice id (einvoice_id).

entitlements

  • GETList entitlements/entitlements?limit=&offset=&feature_id=user-licenses&entity_type=plan_price&entity_id=usd-professional-monthlyRetrieves a list of all the entitlements associated with the specified feature.
  • POSTManage entitlements for a feature/entitlementsCreate, 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…

estimates

  • POSTEstimate for creating a customer and subscription/estimates/create_subscription_for_itemsGenerates 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…
  • POSTCreate a payment schedule estimate/estimates/payment_schedulesGenerates an estimate without creating a payment schedule. This endpoint can be called when you want to preview details of a new payment schedule before…
  • POSTCreate invoice for items estimate/estimates/create_invoice_for_itemsThis endpoint creates an invoice estimate for non-recurring items. You can optionally override the line item name and description displayed on the invoice for…
  • POSTGift subscription estimate for items/estimates/gift_subscription_for_itemsThis endpoint generates an estimate for a subscription that is intended to be a gift. The estimate provides details about the gift sender, gift recipient,…
  • POSTEstimate for updating a subscription/estimates/update_subscription_for_itemsReturns an estimate for updating a subscription. In the response, * subscription_estimate: The details of the changed subscription such as status, next…

events

  • GETList events/events?limit=&offset=&id=8ndk0hbKm&webhook_status=succeeded&event_type=customer_created&source=hosted_page&occurred_at=1349116200&sort_by=Retrieves list of events.
  • GETRetrieve an event/events/:event-idRetrieves a specific event identified by a unique event identifier. Note: Only events that are less than 90 days old will be retrieved.

exports

  • POSTExport customers/exports/customersThis API triggers export of customer data. The exported zip file contains CSV files with customer-related data.
  • POSTExport attached items/exports/attached_itemsThis API triggers export of attached item data. The exported zip file contains CSV files with attached item-related data.
  • POSTExport transactions/exports/transactionsThis API triggers export of transaction data. The exported zip file contains CSV files with transaction-related data.
  • POSTExport Subscription Ramps/exports/rampsStarts an export job for subscription ramps data. The exported zip file contains CSV files with ramp-related data. Best practice For a full data export, use…
  • POSTExport differential price/exports/differential_pricesThis API triggers export of differential price data. The exported zip file contains CSV files with differential price-related data.
  • POSTExport item families/exports/item_familiesThis API triggers export of item family data. The exported zip file contains CSV files with item family-related data.
  • POSTExport invoices/exports/invoicesThis API triggers export of invoice data. The exported zip file contains CSV files with invoice-related data. Invoice Export Best Practice For a full export,…
  • GETRetrieve an export/exports/:export-idThis 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…
  • POSTExport price variants/exports/price_variantsThis API triggers export of price variant data. The exported zip file contains CSV files with price variant-related data.
  • POSTExport items/exports/itemsThis API triggers export of item data. The exported zip file contains CSV files with item-related data.
  • POSTExport deferred revenue reports/exports/deferred_revenueImportant: This report is deprecated. Therefore, the endpoint is also deprecated. This API triggers export for the Deferred Revenue Report. Note: This API…
  • POSTExport revenue recognition reports/exports/revenue_recognitionImportant: This report is deprecated. Therefore, the endpoint is also deprecated. This API triggers export for the revenue recognition report. Note: This API…
  • POSTExport credit notes/exports/credit_notesThis API triggers export of credit note data. The exported zip file contains CSV files with credit note-related data.
  • POSTExport coupons/exports/couponsThis API triggers export of coupon data. The exported zip file contains CSV files with coupon-related data.
  • POSTExport orders/exports/ordersThis API triggers export of order data. The exported zip file contains CSV files with order-related data.
  • POSTExport item prices/exports/item_pricesThis API triggers export of item price data. The exported zip file contains CSV files with item price-related data.
  • POSTExport subscriptions/exports/subscriptionsThis API triggers export of subscription data. The exported zip file contains CSV files with subscription-related data.

features

  • GETList features/features?limit=&offset=&name=User licenses&id=fea-user-licenses&status=active&type=boolean&metered=trueRetrieves a list of features meeting all the conditions specified in the filter parameters.
  • POSTCreate a feature/featuresCreates a new feature. Note: This operation creates non-metered features only. To create a metered feature, use the Create a metered feature operation.
  • POSTDelete a feature/features/:feature-id/deleteDeletes a feature. Any entitlements and subscription entitlements defined for the feature are also removed. This action is not permissible when the status of…
  • GETRetrieve a feature/features/:feature-idRetrieve a specific feature using its ID.
  • POSTUpdate a feature/features/:feature-idUpdates 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…
  • POSTArchive a feature/features/:feature-id/archive_commandArchives an active feature so that no new entitlements or subscription entitlements can be created towards the feature. Any pre-existing item or subscription…
  • POSTActivate a feature/features/:feature-id/activate_commandActivates a draft feature so that any entitlements or subscription entitlements defined towards it take effect immediately. This operation changes the status…
  • POSTReactivate a feature/features/:feature-id/reactivate_commandReactivates an archived feature so that new entitlements or subscription entitlements can be created towards the feature. This operation changes the status of…
  • GETList item entitlements for a feature/features/:feature-id/item_entitlements?limit=&offset=Deprecated This operation is deprecated and no longer maintained. Migrate your integration to List entitlements. Retrieves a list of all the item_entitlement…
  • POSTUpsert or remove item entitlements for a feature/features/:feature-id/item_entitlementsDeprecated This operation is deprecated and no longer maintained. Migrate your integration to Manage entitlements. Warning This operation is not supported…

full_exports

  • GETRetrieve full export status/full_exports/status?table=&date=This endpoint retrieves the status of your data export request.

gateway_request_logs

  • GETRetrieve a gateway request log/gateway_request_logs/:gateway-request-log-log-id
  • GETList gateway request logs/gateway_request_logs?limit=10&offset=string&log_id=&gateway=&status_code=&method=&url=&customer_handle=&invoice_handle=&transaction_handle=&payment_method_handle=&gateway_credential_handle=&payment_attempt_handle=&payment_intent_handle=&operation_name=&operation_type=&source=&invocation_time=&response_received_at=&sort_by=

gateway_webhook_logs

  • GETRetrieve a gateway webhook log/gateway_webhook_logs/:gateway-webhook-log-webhook-id
  • GETList gateway webhook logs/gateway_webhook_logs?limit=10&offset=string&webhook_id=&gateway=&status_code=&method=&url=&id_at_gateway=&customer_handle=&invoice_handle=&transaction_handle=&payment_method_handle=&gateway_credential_handle=&payment_attempt_handle=&payment_intent_handle=&received_at=&sort_by=

gifts

  • POSTCreate a gift subscription for items/gifts/create_for_itemsCreate a gift subscription with items like plans, addons, or charges and gift it to an existing customer.
  • POSTCancel a gift/gifts/:gift-id/cancelThis API allows to cancel gifts. Only gift in 'scheduled' and 'unclaimed' states can be cancelled.
  • POSTUpdate a gift/gifts/:gift-id/update_giftUpdates the attributes of a gift. Prerequisites \& Constraints * The gift must be in the scheduled status.
  • GETList gifts/gifts?limit=&offset=&status=claimed&gift_receiver=&gifter=Retrieves the list of gifts.
  • GETRetrieve a gift/gifts/:gift-idRetrieves a gift subscription. This API accepts the gift 'id' and returns the gift along with the subscription.
  • POSTClaim a gift/gifts/:gift-id/claimClaiming a gift will move the status to 'claimed'. Only gifts in 'unclaimed' state can be claimed.

grant_blocks

  • GETList grant blocks/grant_blocks?limit=&offset=&subscription_id=&unit_id=&account_type=&effective_from=&expires_at=&created_at=&sort_by=Returns a list of grant blocks meeting all the conditions specified in the filter parameters below.

hosted_pages

  • POSTCheckout charge-items and one-time charges/hosted_pages/checkout_one_time_for_itemsCreate 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…
  • POSTExtend subscription/hosted_pages/extend_subscriptionThis API generates a hosted page URL to extend the billing cycle of a subscription. Use one of the following methods to open the hosted page: * In-app modal :…
  • POSTNotify an event/hosted_pages/eventsUse this API to notify Chargebee about important events that occur on your web pages, such as subscription cancellations. An event contains data about…
  • POSTCheckout gift subscription for items/hosted_pages/checkout_gift_for_itemsCreates a hosted page for a customer (called the gifter) to gift a subscription to another customer (called the receiver). Gifter customer resource lookup and…
  • GETList hosted pages/hosted_pages?limit=&offset=&id=Edi69nxpu6BeGBd9Fjcd0tqCSwb0sRcuKa&type=checkout_new&state=succeeded&updated_at=1490784813This API retrieves the list of hosted page resources.
  • POSTCreate a hosted page to view Boleto vouchers/hosted_pages/view_voucherCreates a hosted_page resource of type, view_voucher . When your end customers choose the Boleto payment method, you can generate a voucher for their pending…
  • POSTCollect now/hosted_pages/collect_nowThis API generates a hosted page URL to collect due payments for the customer. Open the hosted page in a new browser tab or window using the url from this…
  • POSTAccept a quote/hosted_pages/accept_quoteThis 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. *…
  • POSTCreate checkout for a new subscription/hosted_pages/checkout_new_for_itemsCreate a Chargebee hosted page to accept payment details from a customer and checkout a new subscription. The following steps describe how best to use this…
  • POSTClaim a gift subscription/hosted_pages/claim_giftThis API generates a hosted page URL to claim a gifted subscription.
  • POSTCreate checkout to update a subscription/hosted_pages/checkout_existing_for_itemsCreate 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…
  • POSTCreate a pre-cancel hosted page/hosted_pages/pre_cancelCreates a hosted_page resource of type pre_cancel . Route canceling users to this page to provide them a retention experience and start saving revenue. The…
  • POSTAcknowledge a hosted page/hosted_pages/:hosted-page-id/acknowledgeWhen a hosted page is successfully completed by the user and processed by Chargebee, its state is automatically changed to succeeded . Acknowledging a hosted…
  • POSTRetrieve direct debit agreement PDF/hosted_pages/retrieve_agreement_pdfThis 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…
  • GETRetrieve a hosted page/hosted_pages/:hosted-page-idWhen you retrieve a hosted page whose status is successful, the content attribute has the following objects based on the type of the hosted page.
  • POSTManage payment sources/hosted_pages/manage_payment_sourcesThis API generates a hosted page URL to add new or update existing payment sources for the customer. Use one of the following methods to open the hosted page:…

in_app_subscriptions

  • POSTRetrieve store subscription/in_app_subscriptions/:in-app-subscription-app-id/retrieveThis API verifies the application id {in_app_subscription_app_id} and receipt then returns the subscription details associated with the purchase. Path…
  • POSTImport receipt/in_app_subscriptions/:in-app-subscription-app-id/import_receiptVerifies an Apple App Store or Google Play Store in-app purchase receipt and imports subscriptions for all historical purchases made by the customer. Tip An…
  • POSTImport subscription without receipt/in_app_subscriptions/:in-app-subscription-app-id/import_subscriptionThe Import Subscriptions endpoint is a Chargebee API that allows you to import historic In-App Subscriptions without using a valid Apple App Store receipt.…
  • POSTProcess purchase command/in_app_subscriptions/:in-app-subscription-app-id/process_purchase_commandVerifies an in-app purchase made by your customer and creates a subscription in Chargebee. Note: If App Store or Play Store products have not been imported to…

invoices

  • POSTDelete line items/invoices/:invoice-id/delete_line_itemsThis endpoint is used to delete line items from "Pending" invoice.
  • POSTRemove credit note from an invoice/invoices/:invoice-id/remove_credit_noteRemoves the specified adjustment credit or refundable credit allocation applied to the invoice. Prerequisites \& Constraints * The invoice status must not be…
  • POSTRemove payment from an invoice/invoices/:invoice-id/remove_paymentRemoves 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…
  • POSTStop dunning for invoice/invoices/:invoice-id/stop_dunningThis 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…
  • POSTApply payments for an invoice/invoices/:invoice-id/apply_paymentsApplies payment to a single invoice. You can either specify individual payment transactions as parameters, or Chargebee applies any available excess payments…
  • POSTApply payment schedule scheme to an invoice/invoices/:invoice-id/apply_payment_schedule_schemeApplying a payment schedule scheme to an invoice creates payment schedules, enabling the invoice to be paid in multiple, scheduled payments. Note: The invoice…
  • POSTVoid an invoice/invoices/:invoice-id/voidVoids the specified invoice. Use this operation when: * The invoice was generated in error. * The invoice amount is incorrect. * The customer requests a…
  • POSTAdd one-time charge to a pending invoice/invoices/:invoice-id/add_chargeAdds 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.…
  • POSTSend an einvoice for invoices/invoices/:invoice-id/send_einvoiceThis endpoint is used to send an e-invoice for invoice. To support cases like TDS and invoice edits, we need to stop auto e-invoice sending and be able to…
  • GETRetrieve payment schedules for an invoice/invoices/:invoice-id/payment_schedulesThis endpoint retrieves payment schedules created for an invoice.
  • POSTWrite off an invoice/invoices/:invoice-id/write_offWrite off the specified invoice. Use this operation to mark invoices as settled when they remain unpaid after multiple attempts to collect payment. Reverse a…
  • POSTAdd a charge-item to a pending invoice/invoices/:invoice-id/add_charge_itemThis 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…
  • POSTPause dunning for invoice/invoices/:invoice-id/pause_dunningPause dunning for the specified invoice until expected_payment_date. Chargebee cancels all configured payment collection retry attempts and dunning email…
  • GETList invoices/invoices?limit=&offset=&include_deleted=&id=INVOICE_654&subscription_id=3bdjnDnsdQn&customer_id=3bdjnDnsdQn&recurring=true&status=paid&price_type=tax_exclusive&date=1394532759&paid_at=1394532759&total=1000&amount_paid=800&amount_adjusted=100&credits_applied=100&amount_due=200&dunning_status=in_progress&payment_owner=payment_customer&updated_at=1243545465&channel=APP STORE&voided_at=1394532759&void_reason_code=Other&sort_by=&exclude=line_items&einvoice=Lists all the Invoices.
  • POSTVoid authorizations before capture/invoices/:invoice-id/void_before_captureVoids all outstanding scheduled-capture authorizations linked to an invoice before capture, then voids or writes off the invoice. Use this operation when an…
  • POSTClose a pending invoice/invoices/:invoice-id/closeInvoices for a subscription are created with a pending status when the subscription has create_pending_invoices attribute set to true. This API call finalizes…
  • POSTApply credits for an invoice/invoices/:invoice-id/apply_creditsApplies 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…
  • POSTSend Invoice Email/invoices/:invoice-id/send_emailSends the invoice email to the customer using the site's published Send Invoice Email Engage notification template. Use this operation to resend or manually…
  • GETRetrieve an invoice/invoices/:invoice-id?line_items_limit=&line_items_offset=Retrieve the invoice for the specified invoice id.
  • POSTCreate invoice for items and one-time charges/invoices/create_for_charge_items_and_chargesCreates an invoice for charge-items and one-time charges. The item prices must belong to items of type charge. You can optionally override the line item name…
  • POSTUpdate invoice details/invoices/:invoice-id/update_detailsThis API allows you to update the invoice Billing/Shipping address, VAT, custom fields, and PO number. During this operation if Billing Info (Billing Address,…
  • POSTRecord an invoice payment/invoices/:invoice-id/record_paymentRecords 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…
  • POSTDelete an invoice/invoices/:invoice-id/deleteDeletes the specified invoice. Void the invoice If the invoice was generated incorrectly, void it instead of deleting it. Voiding preserves the audit trail…
  • POSTImport invoice/invoices/import_invoiceImports an invoice into Chargebee Billing. Use this API to import invoices from your other billing or accounting system into Chargebee Billing. You can import…
  • POSTResume dunning for invoice/invoices/:invoice-id/resume_dunningImmediately resumes dunning for the specified invoice. * If the current time is within the dunning period for the invoice, Chargebee resumes any dunning…
  • POSTRecord tax withheld for an invoice/invoices/:invoice-id/record_tax_withheldRecords tax_withheld by the customer against the invoice specified. This operation is allowed only when all of the following conditions are true: * Tax Amount…
  • POSTResend failed einvoice in invoices/invoices/:invoice-id/resend_einvoiceResend failed einvoice of an invoice to the customer using this API.
  • POSTRemove tax withheld for an invoice/invoices/:invoice-id/remove_tax_withheldRemoves a linked_taxes_withheld record from the invoice specified. This operation is allowed only when all of the following conditions are true: *…
  • GETList payment reference numbers/invoices/payment_reference_numbers?limit=&offset=&id=old_inv_001&payment_reference_number=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…
  • POSTRemove payment schedule scheme from an invoice/invoices/:invoice-id/remove_payment_schedule_schemeCancels remaining unpaid schedule entries on an invoice. Use this when a payment schedule was applied in error or is no longer required. Unpaid schedule…
  • POSTCollect payment for an invoice/invoices/:invoice-id/collect_paymentCollects a specified amount of payment for an invoice, via a specified online payment method. Offline payments When there is no payment method available, and…
  • POSTSync usages/invoices/:invoice-id/sync_usagesUpdates the quantity for metered line_items of an invoice to reflect the latest usage data. Note: This operation is done automatically while closing the…
  • POSTRefund an invoice/invoices/:invoice-id/refundRefunds online payments or online refundable credit notes applied to an invoice. If multiple transactions or credit note allocations are associated with the…
  • POSTRecord refund for an invoice/invoices/:invoice-id/record_refundRecord a full or partial offline refund for an invoice. Use this API to record refunds processed outside Chargebee (for example, directly through a payment…
  • POSTRetrieve invoice as PDF/invoices/:invoice-id/pdfGets the invoice as PDF. The returned URL is secure and allows download. The URL will expire in 60 minutes. Related Tutorial * Check out customer portal…
  • GETDownload e-invoice/invoices/:invoice-id/download_einvoiceDownload 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…
  • GETList payments for an invoice/invoices/:invoice-id/payments?limit=&offset=Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \& automatic) made for this invoice.
  • GETList vouchers for an invoice/invoices/:invoice-id/payment_vouchers?limit=&offset=&status=active, consumed, expired&sort_by=Retrieves vouchers for an invoice in reverse chronological order.

item_families

  • POSTDelete an item family/item_families/:item-family-id/deleteDeletes an item family, marking its status as deleted . This is not allowed if there are active items under the item family. Once deleted, the id and name of…
  • GETList item families/item_families?limit=&offset=&id=family-id&name=family-name&updated_at=1243545465&business_entity_id=business_entity_id&include_site_level_resources=Returns a list of item families satisfying all the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending…
  • POSTCreate an item family/item_familiesThis endpoint creates an item family for your product line or service.
  • GETRetrieve an item family/item_families/:item-family-idThis endpoint retrieves an item family based on the item family id.
  • POSTUpdate an item family/item_families/:item-family-idThis endpoint updates the name and/or description of the item family.

item_prices

  • GETRetrieve an item price/item_prices/:item-price-idThis API retrieves a specific item price using the id.
  • POSTUpdate an item price/item_prices/:item-price-idUpdates an item price with the changes specified. Unspecified item price attributes are not modified.
  • POSTDelete an item price/item_prices/:item-price-id/deleteDeletes 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…
  • GETList applicable item prices for a plan-item price/item_prices/:item-price-id/applicable_item_prices?limit=&offset=&item_id=&sort_by=Returns the set of all applicable addon-item prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a…
  • GETList applicable items for a plan-item price/item_prices/:item-price-id/applicable_items?limit=&offset=&sort_by=Returns the set of all applicable addon-items for a specific plan-item price . This set consists of all addon-items whose item prices can be applied to a…
  • GETList item prices/item_prices?limit=&offset=&id=basic_USD&name=basic USD&pricing_model=flat_fee&item_id=basic&item_family_id=Acme&item_type=plan&currency_code=USD&price_variant_id=tamilNadu-India&trial_period=14&trial_period_unit=day&status=active&updated_at=1243545465&business_entity_id=business_entity_id&include_site_level_resources=&period_unit=month&period=3&channel=APP STORE&sort_by=Returns a list of item prices satisfying all the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending…
  • POSTCreate an item price/item_pricesThis API creates an item price (a price point) for an item.
  • POSTCreate a differential price/item_prices/:item-price-id/differential_pricesCreate a differential price for addon item price, addon item price with tiered pricing, or charge item price.

items

  • GETList items/items?limit=&offset=&id=basic&item_family_id=acme&type=plan&name=basic&item_applicability=all&status=active&is_giftable=true&updated_at=1243545465&enabled_for_checkout=&enabled_in_portal=&metered=true&usage_calculation=SUM_OF_USAGES&channel=APP STORE&business_entity_id=business_entity_id&include_site_level_resources=&sort_by=&bundle_configuration=Returns a list of items satisfying all the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.…
  • POSTCreate an item/itemsCreates a new item.
  • POSTDelete an item/items/:item-id/deleteDeletes an item, marking its status as deleted. This is not allowed if there are active or archived item prices under the item. Once deleted, the id and name…
  • GETRetrieve an item/items/:item-idRetrieve an item resource.
  • POSTUpdate an item/items/:item-idUpdates an item with the changes specified. Unspecified item parameters are not modified.
  • GETList attached items/items/:item-id/attached_items?limit=&offset=&id=bec0c324-adb6-44d3-ad4f-694f449be97c&item_id=basic&type=mandatory&item_type=plan&charge_on_event=subscription_creation&updated_at=1243545465Returns a list of attached items satisfying all the conditions specified in the filter parameters below. The list is sorted by the date of creation in…
  • POSTCreate an attached item/items/:item-id/attached_itemsCreates an attached addon or a charge item for a plan.

API details

Authentication
HTTP Basic authentication (username and password)
Operations
499 operations on 441 pathsPOST 335GET 164
Main resources
subscriptions 48invoices 38customers 36exports 17payment_sources 17hosted_pages 16credit_notes 15quotes 14business_rules 11orders 11
Response formats
application/json
Webhooks
269 described
Description format
OpenAPI 3.1.0, API version 2026-11-12.8ccf0f3db732eac5f7c79ffeda97…

How to test the Chargebee API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Chargebee API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve an address” (GET /addresses?subscription_id=&label=), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Chargebee API?

Chargebee API endpoints from Chargebee It is listed under Payments and has 499 endpoints.

Who publishes the Chargebee API?

It is listed from Chargebee's public API description (an OpenAPI document), not published by Chargebee on Swastik Codes. Anyone who controls chargebee.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Chargebee API?

With HTTP Basic authentication (username and password).

How many endpoints does the Chargebee API have?

499 operations on 441 paths (335 POST, 164 GET). The largest groups are subscriptions, invoices, customers, exports. This listing's collection holds the first 400.

Is forking the Chargebee API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.