diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e43b0f9 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.DS_Store diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c9528f4..cc8dbcb 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,5 +1,5 @@ repos: - repo: https://github.com/gitleaks/gitleaks - rev: v8.16.1 + rev: v8.30.0 hooks: - id: gitleaks diff --git a/README.md b/README.md new file mode 100644 index 0000000..17df567 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Skills for Chargebee + +Official AI agent skills for integrating Chargebee with your apps. + +## Installation + +```shell +npx skills add chargebee/ai --skill +``` diff --git a/cyberHygiene.md b/cyberHygiene.md deleted file mode 100644 index 237848e..0000000 --- a/cyberHygiene.md +++ /dev/null @@ -1,36 +0,0 @@ -This repository was created from a starter template that includes essential configurations to help you ensure your codebase always remains secure by scanning for sensitive information such as API keys, access tokens, and other secrets hardcoded in the codebase. - -## Starter kit files - -### 1. **GitHub Actions Secrets Scanning Workflow** - -- **Path**: `.github/workflows/secrets-scan.yml` -- **What It Is**: A GitHub Actions workflow that automatically scans for secrets in the files modified each time you open a pull request. -- **Why It's Here**: To detect hardcoded secrets in your codebase and prevent it from being exposed. If secrets are found, the workflow will fail, and you'll be notified of the findings so you can take action. - -### 2. **Pre-commit Configuration File** - -- **Path**: `.pre-commit-config.yaml` -- **What It Is**: This file configures pre-commit hooks to run checks on your code before every commit. -- **Why It's Here**: It ensures that secrets are scanned locally before any code is committed, preventing you from accidentally pushing secrets to your repository. - -## Actions to be performed - -**THESE FILES ARE INTEGRAL IN MAINTAINING A SECURE CODEBASE, DO NOT DELETE OR MODIFY THEM** - -**Configure Pre-commit Hooks Locally**: - - - Install `pre-commit` on your machine: - ```bash - brew install pre-commit - ``` - - Install the pre-commit hooks in your repository: - ```bash - cd /path/to/your/repo - pre-commit install - ``` - - Integrate Pre-commit in the build process: - > To ensure that git hooks are consistently configured, you must add the `pre-commit install` step to your build script. - > This is **mandatory** for all repositories. Please refer to [Hardcoded secrets prevention via Git pre-commit hooks](https://mychargebee.atlassian.net/wiki/spaces/ECS/pages/3335618745/Hardcoded+secrets+prevention+via+Git+pre-commit+hooks) for a detailed walkthrough. - -Feel free to contact `#ask-security` if you face any issues. \ No newline at end of file diff --git a/skills/chargebee-integration/SKILL.md b/skills/chargebee-integration/SKILL.md new file mode 100644 index 0000000..13f7fc8 --- /dev/null +++ b/skills/chargebee-integration/SKILL.md @@ -0,0 +1,127 @@ +--- +name: chargebee-integration +description: Comprehensive integration guide for Chargebee billing platform. Provides API integration patterns, webhook handling, SDK usage, and schema references for billing operations. Use when working with Chargebee for (1) API integration and REST endpoint calls, (2) Processing webhook events, (3) Customer management operations, (4) Subscription lifecycle handling, (5) Payment and invoice processing, (6) Any other billing-related integration tasks with Chargebee platform. +--- + +# Chargebee Integration + +This skill helps you integrate [Chargebee Billing](https://www.chargebee.com/docs/billing/2.0/getting-started/accessing_chargebee.md) with your app or website. + +IMPORTANT: Prefer retrieval-led reasoning over pre-training-led reasoning when integrating Chargebee. + +## Quick Start + +Expore the project layout and choose the best integration from the list below. Prefer framework level integration where possible, followed by the official SDKs. Fallback to REST API only if the other options aren't feasible. + +### Frameworks + +- **Laravel Cashier** - https://github.com/chargebee/cashier-chargebee/blob/main/DOCUMENTATION.md + +For the frameworks below, use the `chargebee-init` CLI which currently integrates checkout, portal and webhooks: + +- **Next.js** +- **Express** + +Invoke the CLI with: `npx chargebee-init@latest --dangerously-skip-checks --path=` to skip all input prompts. + +### SDKs + +Chargebee provides official SDKs for multiple languages. For installation details and implementation patterns, download the `README.md` file from the GitHub repository. + +- **Java**: https://github.com/chargebee/chargebee-java +- **Python**: https://github.com/chargebee/chargebee-python +- **Node.js**: https://github.com/chargebee/chargebee-node +- **Go**: https://github.com/chargebee/chargebee-go +- **PHP**: https://github.com/chargebee/chargebee-php +- **Ruby**: https://github.com/chargebee/chargebee-ruby +- **.NET**: https://github.com/chargebee/chargebee-dotnet + +For details on data model, supported operations, and other available resources, lookup the index at **references/api-reference.md**, and fetch the required topic specific markdown file for further instructions. + +### REST API + +The REST API can be consumed directly via the site specific HTTPS endpoint. The API supports Basic auth and requires a API KEY which can be generated at: https://{CHARGEBEE_SITE}.chargebee.com/apikeys_and_webhooks/api. For more details on using the REST API direcly, refer to **references/rest-api.md**. + + +```python +# Using requests library +import requests + +CHARGEBEE_SITE = "your-site" +CHARGEBEE_API_KEY = "your_api_key" + +headers = { + "Authorization": f"Basic {CHARGEBEE_API_KEY}", + "Content-Type": "application/json" +} + +base_url = f"https://{CHARGEBEE_SITE}.chargebee.com/api/v2" +response = requests.get( + f"{base_url}/customers/{customer_id}", + headers=headers +) + +# Using Python SDK +import chargebee +chargebee.configure(CHARGEBEE_API_KEY, CHARGEBEE_SITE) +result = chargebee.Customer.retrieve(customer_id) +customer = result.customer +``` + +### Common Operations + +- Customer CRUD operations +- Subscription management +- Invoice operations +- Payment method handling +- Plan and addon management +- Usage based billing + + +### Webhook Integration + +Chargebee sends webhook events for important billing events. Webhook handlers should: + +1. Verify webhook signatures for security +2. Handle idempotency (events may be sent multiple times) +3. Return 200 OK quickly (process asynchronously if needed) +4. Handle various event types appropriately + +#### Basic Webhook Handler Pattern + +```python +from flask import Flask, request +import chargebee + +app = Flask(__name__) + +@app.route('/chargebee/webhook', methods=['POST']) +def handle_webhook(): + payload = request.data + signature = request.headers.get('X-Chargebee-Signature') + + # Verify signature (recommended for security) + # chargebee.Webhook.verify_signature(payload, signature) + + event = request.json + event_type = event['event_type'] + + # Process based on event type + if event_type == 'subscription_created': + handle_subscription_created(event['content']) + elif event_type == 'subscription_cancelled': + handle_subscription_cancelled(event['content']) + # ... handle other events + + return '', 200 +``` + +For complete webhook event schemas and all event types, see **references/webhooks.md**. + + +## References + +- **references/api-reference.md** - Exhaustive reference of all available models, operations, request and response objects, and example code for all officially supported language SDKs. Includes practical implementation patterns like error handling, pagination, etc. +- **references/rest-api.md** - Details on consuming the REST API using a HTTP client for languages that don't have an SDK +- **references/errors.md** - All possible error codes that the API may return +- **references/events.md** - List of supported webhook events diff --git a/skills/chargebee-integration/references/api-reference.md b/skills/chargebee-integration/references/api-reference.md new file mode 100644 index 0000000..ec56a5d --- /dev/null +++ b/skills/chargebee-integration/references/api-reference.md @@ -0,0 +1,591 @@ +# Getting started + + - [Getting started](https://apidocs.chargebee.com/docs/api/getting-started.md) + - [Authentication](https://apidocs.chargebee.com/docs/api/auth.md) + - [Versioning](https://apidocs.chargebee.com/docs/api/versioning.md) + - [List operations](https://apidocs.chargebee.com/docs/api/list-ops.md) + - [Error handling & rate limits](https://apidocs.chargebee.com/docs/api/error-handling.md) + - [Idempotent requests](https://apidocs.chargebee.com/docs/api/idempotency.md) + - [Webhooks](https://apidocs.chargebee.com/docs/api/webhooks.md) + - [Advanced features](https://apidocs.chargebee.com/docs/api/advanced-features.md) + - [API Changelog](https://www.chargebee.com/help/api-updates/) + +# Business entities + +- Business entities + - [Business entity object](https://apidocs.chargebee.com/docs/api/business_entities/business-entity-object.md) + - [Transfer a customer to another business entity](https://apidocs.chargebee.com/docs/api/business_entities/transfer-resources-to-another-business-entity.md) + - [List business entity transfers](https://apidocs.chargebee.com/docs/api/business_entities/list-the-business-entity-transfers.md) +- Business entity transfers + - [Business entity transfer object](https://apidocs.chargebee.com/docs/api/business_entity_transfers/business-entity-transfer-object.md) + +# Customers + +- Customers + - [Customer object](https://apidocs.chargebee.com/docs/api/customers/customer-object.md) + - [Record an excess payment for a customer](https://apidocs.chargebee.com/docs/api/customers/record-an-excess-payment-for-a-customer.md) + - [Create a customer](https://apidocs.chargebee.com/docs/api/customers/create-a-customer.md) + - [Collect payment for customer](https://apidocs.chargebee.com/docs/api/customers/collect-payment-for-customer.md) + - [List customers](https://apidocs.chargebee.com/docs/api/customers/list-customers.md) + - [Delete a customer](https://apidocs.chargebee.com/docs/api/customers/delete-a-customer.md) + - [Retrieve a customer](https://apidocs.chargebee.com/docs/api/customers/retrieve-a-customer.md) + - [Move a customer](https://apidocs.chargebee.com/docs/api/customers/move-a-customer.md) + - [Update a customer](https://apidocs.chargebee.com/docs/api/customers/update-a-customer.md) + - [Change billing date](https://apidocs.chargebee.com/docs/api/customers/change-billing-date.md) + - [Update payment method for a customer](https://apidocs.chargebee.com/docs/api/customers/update-payment-method-for-a-customer.md) + - [Merge customers](https://apidocs.chargebee.com/docs/api/customers/merge-customers.md) + - [Update billing info for a customer](https://apidocs.chargebee.com/docs/api/customers/update-billing-info-for-a-customer.md) + - [Clear Personal Data of a customer](https://apidocs.chargebee.com/docs/api/customers/clear-personal-data-of-a-customer.md) + - [List of contacts for a customer](https://apidocs.chargebee.com/docs/api/customers/list-of-contacts-for-a-customer.md) + - [Assign payment role](https://apidocs.chargebee.com/docs/api/customers/assign-payment-role.md) + - [Add contacts to a customer](https://apidocs.chargebee.com/docs/api/customers/add-contacts-to-a-customer.md) + - [Update contacts for a customer](https://apidocs.chargebee.com/docs/api/customers/update-contacts-for-a-customer.md) + - [Delete contacts for a customer](https://apidocs.chargebee.com/docs/api/customers/delete-contacts-for-a-customer.md) + - [Get paginated account hierarchy for a customer](https://apidocs.chargebee.com/docs/api/customers/list-hierarchy-details.md) + - [Get account hierarchy for a customer](https://apidocs.chargebee.com/docs/api/customers/get-hierarchy.md) + - [Update account hierarchy access settings for a customer](https://apidocs.chargebee.com/docs/api/customers/update-hierarchy-access-settings-for-a-customer.md) + - [Link a customer to an account hierarchy](https://apidocs.chargebee.com/docs/api/customers/link-a-customer.md) + - [Unlink a customer from its parent account](https://apidocs.chargebee.com/docs/api/customers/delink-a-customer.md) +- Hierarchies + - [Hierarchy object](https://apidocs.chargebee.com/docs/api/hierarchies/hierarchy-object.md) + +# Subscriptions + +- Subscriptions + - [Subscription object](https://apidocs.chargebee.com/docs/api/subscriptions/subscription-object.md) + - [Charge Future Renewals](https://apidocs.chargebee.com/docs/api/subscriptions/charge-future-renewals.md) + - [Create subscription for Items](https://apidocs.chargebee.com/docs/api/subscriptions/create-subscription-for-items.md) + - [Edit Advance Invoice Schedule](https://apidocs.chargebee.com/docs/api/subscriptions/edit-advance-invoice-schedule.md) + - [List subscriptions](https://apidocs.chargebee.com/docs/api/subscriptions/list-subscriptions.md) + - [Retrieve advance invoice](https://apidocs.chargebee.com/docs/api/subscriptions/retrieve-advance-invoice.md) + - [List contract terms for a subscription](https://apidocs.chargebee.com/docs/api/subscriptions/list-contract-terms-for-a-subscription.md) + - [Remove an advance invoice schedules](https://apidocs.chargebee.com/docs/api/subscriptions/remove-an-advance-invoice-schedules.md) + - [List discounts for a subscription](https://apidocs.chargebee.com/docs/api/subscriptions/list-discounts-for-a-subscription.md) + - [Regenerate an invoice](https://apidocs.chargebee.com/docs/api/subscriptions/regenerate-an-invoice.md) + - [Retrieve a subscription](https://apidocs.chargebee.com/docs/api/subscriptions/retrieve-a-subscription.md) + - [Import contract term](https://apidocs.chargebee.com/docs/api/subscriptions/import-contract-term.md) + - [Import unbilled charges](https://apidocs.chargebee.com/docs/api/subscriptions/import-unbilled-charges.md) + - [Retrieve with scheduled changes](https://apidocs.chargebee.com/docs/api/subscriptions/retrieve-with-scheduled-changes.md) + - [Import subscription for Items](https://apidocs.chargebee.com/docs/api/subscriptions/import-subscription-for-items.md) + - [Remove scheduled changes](https://apidocs.chargebee.com/docs/api/subscriptions/remove-scheduled-changes.md) + - [Override Billing Profile](https://apidocs.chargebee.com/docs/api/subscriptions/override-billing-profile.md) + - [Remove scheduled cancellation](https://apidocs.chargebee.com/docs/api/subscriptions/remove-scheduled-cancellation.md) + - [Delete a subscription](https://apidocs.chargebee.com/docs/api/subscriptions/delete-a-subscription.md) + - [Remove coupons](https://apidocs.chargebee.com/docs/api/subscriptions/remove-coupons.md) + - [Pause a subscription](https://apidocs.chargebee.com/docs/api/subscriptions/pause-a-subscription.md) + - [Update subscription for items](https://apidocs.chargebee.com/docs/api/subscriptions/update-subscription-for-items.md) + - [Cancel subscription for items](https://apidocs.chargebee.com/docs/api/subscriptions/cancel-subscription-for-items.md) + - [Change term end](https://apidocs.chargebee.com/docs/api/subscriptions/change-term-end.md) + - [Resume a subscription](https://apidocs.chargebee.com/docs/api/subscriptions/resume-a-subscription.md) + - [Reactivate a subscription](https://apidocs.chargebee.com/docs/api/subscriptions/reactivate-a-subscription.md) + - [Remove scheduled pause](https://apidocs.chargebee.com/docs/api/subscriptions/remove-scheduled-pause.md) + - [Add charge at term end](https://apidocs.chargebee.com/docs/api/subscriptions/add-charge-at-term-end.md) + - [Remove scheduled resumption](https://apidocs.chargebee.com/docs/api/subscriptions/remove-scheduled-resumption.md) + - [Move a subscription](https://apidocs.chargebee.com/docs/api/subscriptions/move-a-subscription.md) +- Ramps + - [Ramp object](https://apidocs.chargebee.com/docs/api/ramps/ramp-object.md) + - [Create a subscription ramp](https://apidocs.chargebee.com/docs/api/ramps/create-a-ramp.md) + - [Update a subscription ramp](https://apidocs.chargebee.com/docs/api/ramps/update-a-subscription-ramp.md) + - [List subscription ramps](https://apidocs.chargebee.com/docs/api/ramps/list-ramps.md) + - [Delete a subscription ramp](https://apidocs.chargebee.com/docs/api/ramps/delete-a-ramp.md) + - [Retrieve a subscription ramp](https://apidocs.chargebee.com/docs/api/ramps/retrieve-a-ramp.md) +- Usages + - [Usage object](https://apidocs.chargebee.com/docs/api/usages/usage-object.md) + - [Delete a usage](https://apidocs.chargebee.com/docs/api/usages/delete-a-usage.md) + - [Create a usage](https://apidocs.chargebee.com/docs/api/usages/create-a-usage.md) + - [List usages](https://apidocs.chargebee.com/docs/api/usages/list-usages.md) + - [Retrieve a usage](https://apidocs.chargebee.com/docs/api/usages/retrieve-a-usage.md) + - [Retrieve Usages for an Invoice as PDF](https://apidocs.chargebee.com/docs/api/usages/retrieve-usages-for-an-invoice-as-pdf.md) +- Discounts + - [Discount object](https://apidocs.chargebee.com/docs/api/discounts/discount-object.md) +- Contract terms + - [Contract term object](https://apidocs.chargebee.com/docs/api/contract_terms/contract-term-object.md) +- Gifts + - [Gift object](https://apidocs.chargebee.com/docs/api/gifts/gift-object.md) + - [Claim a gift](https://apidocs.chargebee.com/docs/api/gifts/claim-a-gift.md) + - [Create a gift subscription for items](https://apidocs.chargebee.com/docs/api/gifts/create-a-gift-subscription-for-items.md) + - [Cancel a gift](https://apidocs.chargebee.com/docs/api/gifts/cancel-a-gift.md) + - [Retrieve a gift](https://apidocs.chargebee.com/docs/api/gifts/retrieve-a-gift.md) + - [Update a gift](https://apidocs.chargebee.com/docs/api/gifts/update-a-gift.md) + - [List gifts](https://apidocs.chargebee.com/docs/api/gifts/list-gifts.md) +- Addresses + - [Address object](https://apidocs.chargebee.com/docs/api/addresses/address-object.md) + - [Update an address](https://apidocs.chargebee.com/docs/api/addresses/update-an-address.md) + - [Retrieve an address](https://apidocs.chargebee.com/docs/api/addresses/retrieve-an-address.md) + +# In-app subscriptions + +- In-app subscriptions + - [In app subscription object](https://apidocs.chargebee.com/docs/api/in_app_subscriptions/in-app-subscription-object.md) + - [Process Purchase Command](https://apidocs.chargebee.com/docs/api/in_app_subscriptions/process-purchase-command.md) + - [Import Receipt](https://apidocs.chargebee.com/docs/api/in_app_subscriptions/import-receipt.md) + - [Import Subscription Without Receipt](https://apidocs.chargebee.com/docs/api/in_app_subscriptions/import-subscription-without-receipt.md) + - [Retrieve Store Subscription](https://apidocs.chargebee.com/docs/api/in_app_subscriptions/retrieve-store-subscription.md) +- Non subscriptions + - [Non subscription object](https://apidocs.chargebee.com/docs/api/non_subscriptions/non-subscription-object.md) + - [One time purchase](https://apidocs.chargebee.com/docs/api/non_subscriptions/one-time-purchase.md) +- [In-app purchase events](https://apidocs.chargebee.com/docs/api/in_app_purchase_events.md) + +# Recorded purchases + +- Recorded purchases + - [Recorded purchase object](https://apidocs.chargebee.com/docs/api/recorded_purchases/recorded-purchase-object.md) + - [Record a purchase](https://apidocs.chargebee.com/docs/api/recorded_purchases/record-a-purchase.md) + - [Retrieve a recorded purchase](https://apidocs.chargebee.com/docs/api/recorded_purchases/retrieve-a-recorded-purchase.md) +- Omnichannel subscriptions + - [Omnichannel subscription object](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/omnichannel-subscription-object.md) + - [Retrieve an Omnichannel subscription](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/retrieve-an-omnichannel-subscription.md) + - [List Omnichannel subscriptions](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions.md) + - [List Omnichannel transactions of an Omnichannel subscription](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-transactions-of-an-omnichannel-subscription.md) + - [Move an Omnichannel subscription](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/move-an-omnichannel-subscription.md) +- Omnichannel subscription items + - [Omnichannel subscription item object](https://apidocs.chargebee.com/docs/api/omnichannel_subscription_items/omnichannel-subscription-item-object.md) + - [List scheduled changes for omnichannel subscription item](https://apidocs.chargebee.com/docs/api/omnichannel_subscription_items/list-scheduled-changes-for-omnichannel-subscription-item.md) +- Omnichannel transactions + - [Omnichannel transaction object](https://apidocs.chargebee.com/docs/api/omnichannel_transactions/omnichannel-transaction-object.md) +- Omnichannel one time orders + - [Omnichannel one time order object](https://apidocs.chargebee.com/docs/api/omnichannel_one_time_orders/omnichannel-one-time-order-object.md) + - [Retrieve an one time order one time order](https://apidocs.chargebee.com/docs/api/omnichannel_one_time_orders/retrieve-an-omnichannel-one-time-order.md) + - [List Omnichannel one time orders](https://apidocs.chargebee.com/docs/api/omnichannel_one_time_orders/list-omnichannel-one-time-orders.md) +- [Omnichannel events](https://apidocs.chargebee.com/docs/api/omnichannel_events.md) +- [Omnichannel statuses](https://apidocs.chargebee.com/docs/api/omnichannel_statuses.md) + +# Invoices + +- Invoices + - [Invoice object](https://apidocs.chargebee.com/docs/api/invoices/invoice-object.md) + - [Collect payment for an invoice](https://apidocs.chargebee.com/docs/api/invoices/collect-payment-for-an-invoice.md) + - [Create invoice for items and one-time charges](https://apidocs.chargebee.com/docs/api/invoices/create-invoice-for-items-and-one-time-charges.md) + - [Record an invoice payment](https://apidocs.chargebee.com/docs/api/invoices/record-an-invoice-payment.md) + - [Stop dunning for invoice](https://apidocs.chargebee.com/docs/api/invoices/stop-dunning-for-invoice.md) + - [Pause dunning for invoice](https://apidocs.chargebee.com/docs/api/invoices/pause-dunning-for-invoice.md) + - [Resume dunning for invoice](https://apidocs.chargebee.com/docs/api/invoices/resume-dunning-for-invoice.md) + - [Record tax withheld for an invoice](https://apidocs.chargebee.com/docs/api/invoices/record-tax-withheld-for-an-invoice.md) + - [Import invoice](https://apidocs.chargebee.com/docs/api/invoices/import-invoice.md) + - [Remove tax withheld for an invoice](https://apidocs.chargebee.com/docs/api/invoices/remove-tax-withheld-for-an-invoice.md) + - [Apply payments for an invoice](https://apidocs.chargebee.com/docs/api/invoices/apply-payments-for-an-invoice.md) + - [Refund an invoice](https://apidocs.chargebee.com/docs/api/invoices/refund-an-invoice.md) + - [Sync usages](https://apidocs.chargebee.com/docs/api/invoices/sync-usages.md) + - [Record refund for an invoice](https://apidocs.chargebee.com/docs/api/invoices/record-refund-for-an-invoice.md) + - [Apply credits for an invoice](https://apidocs.chargebee.com/docs/api/invoices/apply-credits-for-an-invoice.md) + - [Remove payment from an invoice](https://apidocs.chargebee.com/docs/api/invoices/remove-payment-from-an-invoice.md) + - [List invoices](https://apidocs.chargebee.com/docs/api/invoices/list-invoices.md) + - [Remove credit note from an invoice](https://apidocs.chargebee.com/docs/api/invoices/remove-credit-note-from-an-invoice.md) + - [Retrieve an invoice](https://apidocs.chargebee.com/docs/api/invoices/retrieve-an-invoice.md) + - [Void an invoice](https://apidocs.chargebee.com/docs/api/invoices/void-an-invoice.md) + - [Retrieve Invoice as PDF](https://apidocs.chargebee.com/docs/api/invoices/retrieve-invoice-as-pdf.md) + - [Write off an invoice](https://apidocs.chargebee.com/docs/api/invoices/write-off-an-invoice.md) + - [Download e-invoice](https://apidocs.chargebee.com/docs/api/invoices/download-e-invoice.md) + - [Delete an invoice](https://apidocs.chargebee.com/docs/api/invoices/delete-an-invoice.md) + - [Add one-time charge to a pending invoice](https://apidocs.chargebee.com/docs/api/invoices/add-one-time-charge-to-a-pending-invoice.md) + - [Update invoice details](https://apidocs.chargebee.com/docs/api/invoices/update-invoice-details.md) + - [Add a charge-item to a pending invoice](https://apidocs.chargebee.com/docs/api/invoices/add-a-charge-item-to-a-pending-invoice.md) + - [Resend failed einvoice in invoices](https://apidocs.chargebee.com/docs/api/invoices/resend-failed-einvoice-in-invoices.md) + - [Close a pending invoice](https://apidocs.chargebee.com/docs/api/invoices/close-a-pending-invoice.md) + - [Delete Line Items](https://apidocs.chargebee.com/docs/api/invoices/delete-line-items.md) + - [Send an einvoice for invoices](https://apidocs.chargebee.com/docs/api/invoices/send-an-einvoice-for-invoices.md) + - [List payment reference numbers](https://apidocs.chargebee.com/docs/api/invoices/list-payment-reference-numbers.md) + - [Apply payment schedule scheme to an invoice](https://apidocs.chargebee.com/docs/api/invoices/apply-payment-schedule-scheme-to-an-invoice.md) + - [Retrieve payment schedules for an invoice](https://apidocs.chargebee.com/docs/api/invoices/retrieve-payment-schedules-for-an-invoice.md) +- Advance invoice schedules + - [Advance invoice schedule object](https://apidocs.chargebee.com/docs/api/advance_invoice_schedules/advance-invoice-schedule-object.md) +- Credit notes + - [Credit note object](https://apidocs.chargebee.com/docs/api/credit_notes/credit-note-object.md) + - [Record refund for a credit note](https://apidocs.chargebee.com/docs/api/credit_notes/record-refund-for-a-credit-note.md) + - [Create credit note](https://apidocs.chargebee.com/docs/api/credit_notes/create-credit-note.md) + - [Void a credit note](https://apidocs.chargebee.com/docs/api/credit_notes/void-a-credit-note.md) + - [Retrieve a credit note](https://apidocs.chargebee.com/docs/api/credit_notes/retrieve-a-credit-note.md) + - [List credit notes](https://apidocs.chargebee.com/docs/api/credit_notes/list-credit-notes.md) + - [Retrieve credit note as PDF](https://apidocs.chargebee.com/docs/api/credit_notes/retrieve-credit-note-as-pdf.md) + - [Delete a credit Note](https://apidocs.chargebee.com/docs/api/credit_notes/delete-a-credit-note.md) + - [Download e-invoice for credit note](https://apidocs.chargebee.com/docs/api/credit_notes/download-e-invoice-for-credit-note.md) + - [Remove tax withheld refunds from a credit note](https://apidocs.chargebee.com/docs/api/credit_notes/remove-tax-withheld-refunds-from-a-credit-note.md) + - [Refund a credit note](https://apidocs.chargebee.com/docs/api/credit_notes/refund-a-credit-note.md) + - [Resend failed einvoice in credit notes](https://apidocs.chargebee.com/docs/api/credit_notes/resend-failed-einvoice-in-credit-notes.md) + - [Import credit note](https://apidocs.chargebee.com/docs/api/credit_notes/import-credit-note.md) + - [Send an einvoice for credit notes](https://apidocs.chargebee.com/docs/api/credit_notes/send-an-einvoice-for-credit-notes.md) +- Promotional credits + - [Promotional credit object](https://apidocs.chargebee.com/docs/api/promotional_credits/promotional-credit-object.md) + - [Set Promotional Credits](https://apidocs.chargebee.com/docs/api/promotional_credits/set-promotional-credits.md) + - [Add Promotional Credits](https://apidocs.chargebee.com/docs/api/promotional_credits/add-promotional-credits.md) + - [List promotional credits](https://apidocs.chargebee.com/docs/api/promotional_credits/list-promotional-credits.md) + - [Deduct Promotional Credits](https://apidocs.chargebee.com/docs/api/promotional_credits/deduct-promotional-credits.md) + - [Retrieve a promotional credit](https://apidocs.chargebee.com/docs/api/promotional_credits/retrieve-a-promotional-credit.md) +- Unbilled charges + - [Unbilled charge object](https://apidocs.chargebee.com/docs/api/unbilled_charges/unbilled-charge-object.md) + - [Delete an unbilled charge](https://apidocs.chargebee.com/docs/api/unbilled_charges/delete-an-unbilled-charge.md) + - [Create unbilled charges for item subscription](https://apidocs.chargebee.com/docs/api/unbilled_charges/create-unbilled-charges-for-item-subscription.md) + - [List unbilled charges](https://apidocs.chargebee.com/docs/api/unbilled_charges/list-unbilled-charges.md) + - [Create an invoice for unbilled charges](https://apidocs.chargebee.com/docs/api/unbilled_charges/create-an-invoice-for-unbilled-charges.md) + - [Create an estimate for unbilled charges](https://apidocs.chargebee.com/docs/api/unbilled_charges/create-an-estimate-for-unbilled-charges.md) +- Payment reference numbers + - [Payment reference number object](https://apidocs.chargebee.com/docs/api/payment_reference_numbers/payment-reference-number-object.md) +- Payment schedules + - [Payment schedule object](https://apidocs.chargebee.com/docs/api/payment_schedules/payment-schedule-object.md) +- Payment schedule schemes + - [Payment schedule scheme object](https://apidocs.chargebee.com/docs/api/payment_schedule_schemes/payment-schedule-scheme-object.md) + - [Create a payment schedule scheme](https://apidocs.chargebee.com/docs/api/payment_schedule_schemes/create-a-payment-schedule-scheme.md) + - [Retrieve a payment schedule scheme](https://apidocs.chargebee.com/docs/api/payment_schedule_schemes/retrieve-a-payment-schedule-scheme.md) + - [Delete a payment schedule scheme](https://apidocs.chargebee.com/docs/api/payment_schedule_schemes/delete-a-payment-schedule-scheme.md) + +# Quotes + +- Quotes + - [Quote object](https://apidocs.chargebee.com/docs/api/quotes/quote-object.md) + - [List quotes](https://apidocs.chargebee.com/docs/api/quotes/list-quotes.md) + - [Retrieve a quote](https://apidocs.chargebee.com/docs/api/quotes/retrieve-a-quote.md) + - [List quote line groups](https://apidocs.chargebee.com/docs/api/quotes/list-quote-line-groups.md) + - [Create a quote for subscription creation](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items.md) + - [Convert a quote](https://apidocs.chargebee.com/docs/api/quotes/convert-a-quote.md) + - [Edit a quote for subscription creation](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items.md) + - [Update quote status](https://apidocs.chargebee.com/docs/api/quotes/update-quote-status.md) + - [Create a quote for subscription update](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-update-subscription-items.md) + - [Extend expiry date](https://apidocs.chargebee.com/docs/api/quotes/extend-expiry-date.md) + - [Edit a quote for subscription update](https://apidocs.chargebee.com/docs/api/quotes/edit-update-subscription-quote-for-items.md) + - [Delete a quote](https://apidocs.chargebee.com/docs/api/quotes/delete-a-quote.md) + - [Create a quote for charges and charge items](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-charge-and-charge-items.md) + - [Retrieve a quote as PDF](https://apidocs.chargebee.com/docs/api/quotes/retrieve-quote-as-pdf.md) + - [Edit a quote for charges and charge items](https://apidocs.chargebee.com/docs/api/quotes/edit-quote-for-charge-items-and-charges.md) +- Quotes line groups + - [Quote line group object](https://apidocs.chargebee.com/docs/api/quote_line_groups/quote-line-group-object.md) +- Quoted subscriptions + - [Quoted subscription object](https://apidocs.chargebee.com/docs/api/quoted_subscriptions/quoted-subscription-object.md) +- Quoted charges + - [Quoted charge object](https://apidocs.chargebee.com/docs/api/quoted_charges/quoted-charge-object.md) +- Quoted ramps + - [Quoted ramp object](https://apidocs.chargebee.com/docs/api/quoted_ramps/quoted-ramp-object.md) + +# Estimates + +- [Estimate object](https://apidocs.chargebee.com/docs/api/estimates/estimate-object.md) +- [Upcoming invoices estimate](https://apidocs.chargebee.com/docs/api/estimates/upcoming-invoices-estimate.md) +- [Estimate for creating a customer and subscription](https://apidocs.chargebee.com/docs/api/estimates/estimate-for-creating-a-customer-and-subscription.md) +- [Subscription change term end estimate](https://apidocs.chargebee.com/docs/api/estimates/subscription-change-term-end-estimate.md) +- [Estimate for creating a subscription](https://apidocs.chargebee.com/docs/api/estimates/estimate-for-creating-a-subscription.md) +- [Cancel subscription for items estimate](https://apidocs.chargebee.com/docs/api/estimates/cancel-subscription-for-items-estimate.md) +- [Estimate for updating a subscription](https://apidocs.chargebee.com/docs/api/estimates/estimate-for-updating-a-subscription.md) +- [Pause subscription estimate](https://apidocs.chargebee.com/docs/api/estimates/pause-subscription-estimate.md) +- [Subscription renewal estimate](https://apidocs.chargebee.com/docs/api/estimates/subscription-renewal-estimate.md) +- [Resume subscription estimate](https://apidocs.chargebee.com/docs/api/estimates/resume-subscription-estimate.md) +- [Advance invoice estimate](https://apidocs.chargebee.com/docs/api/estimates/advance-invoice-estimate.md) +- [Gift subscription estimate for items](https://apidocs.chargebee.com/docs/api/estimates/gift-subscription-estimate-for-items.md) +- [Regenerate Invoice Estimate](https://apidocs.chargebee.com/docs/api/estimates/regenerate-invoice-estimate.md) +- [Create invoice for items estimate](https://apidocs.chargebee.com/docs/api/estimates/create-invoice-for-items-estimate.md) +- [Create a payment schedule estimate](https://apidocs.chargebee.com/docs/api/estimates/estimates-for-payment-schedules.md) + +# Orders + +- [Order object](https://apidocs.chargebee.com/docs/api/orders/order-object.md) +- [Create a refundable credit note](https://apidocs.chargebee.com/docs/api/orders/create-a-refundable-credit-note.md) +- [Create an order](https://apidocs.chargebee.com/docs/api/orders/create-an-order.md) +- [Reopen a cancelled order](https://apidocs.chargebee.com/docs/api/orders/reopen-a-cancelled-order.md) +- [Update an order](https://apidocs.chargebee.com/docs/api/orders/update-an-order.md) +- [Retrieve an order](https://apidocs.chargebee.com/docs/api/orders/retrieve-an-order.md) +- [Import an order](https://apidocs.chargebee.com/docs/api/orders/import-an-order.md) +- [Delete an imported order](https://apidocs.chargebee.com/docs/api/orders/delete-an-imported-order.md) +- [Assign order number](https://apidocs.chargebee.com/docs/api/orders/assign-order-number.md) +- [List orders](https://apidocs.chargebee.com/docs/api/orders/list-orders.md) +- [Cancel an order](https://apidocs.chargebee.com/docs/api/orders/cancel-an-order.md) +- [Resend an order](https://apidocs.chargebee.com/docs/api/orders/resend-an-order.md) + +# Product Catalog + +- Item families + - [Item family object](https://apidocs.chargebee.com/docs/api/item_families/item-family-object.md) + - [List item families](https://apidocs.chargebee.com/docs/api/item_families/list-item-families.md) + - [Create an item family](https://apidocs.chargebee.com/docs/api/item_families/create-an-item-family.md) + - [Update an item family](https://apidocs.chargebee.com/docs/api/item_families/update-an-item-family.md) + - [Retrieve an item family](https://apidocs.chargebee.com/docs/api/item_families/retrieve-an-item-family.md) + - [Delete an item family](https://apidocs.chargebee.com/docs/api/item_families/delete-an-item-family.md) +- Items + - [Item object](https://apidocs.chargebee.com/docs/api/items/item-object.md) + - [Update an item](https://apidocs.chargebee.com/docs/api/items/update-an-item.md) + - [Create an item](https://apidocs.chargebee.com/docs/api/items/create-an-item.md) + - [List items](https://apidocs.chargebee.com/docs/api/items/list-items.md) + - [Retrieve an item](https://apidocs.chargebee.com/docs/api/items/retrieve-an-item.md) + - [Delete an item](https://apidocs.chargebee.com/docs/api/items/delete-an-item.md) +- Item prices + - [Item price object](https://apidocs.chargebee.com/docs/api/item_prices/item-price-object.md) + - [List item prices](https://apidocs.chargebee.com/docs/api/item_prices/list-item-prices.md) + - [Create an item price](https://apidocs.chargebee.com/docs/api/item_prices/create-an-item-price.md) + - [Delete an item price](https://apidocs.chargebee.com/docs/api/item_prices/delete-an-item-price.md) + - [Retrieve an item price](https://apidocs.chargebee.com/docs/api/item_prices/retrieve-an-item-price.md) + - [List applicable items for a plan-item price](https://apidocs.chargebee.com/docs/api/item_prices/list-applicable-items-for-a-plan-item-price.md) + - [Update an item price](https://apidocs.chargebee.com/docs/api/item_prices/update-an-item-price.md) + - [List applicable item prices for a plan-item price](https://apidocs.chargebee.com/docs/api/item_prices/list-applicable-item-prices-for-a-plan-item-price.md) +- Attached items + - [Attached item object](https://apidocs.chargebee.com/docs/api/attached_items/attached-item-object.md) + - [Retrieve an attached item](https://apidocs.chargebee.com/docs/api/attached_items/retrieve-an-attached-item-.md) + - [Create an attached item](https://apidocs.chargebee.com/docs/api/attached_items/create-an-attached-item.md) + - [Delete an attached item](https://apidocs.chargebee.com/docs/api/attached_items/delete-an-attached-item.md) + - [Update an attached item](https://apidocs.chargebee.com/docs/api/attached_items/update-an-attached-item.md) + - [List attached items](https://apidocs.chargebee.com/docs/api/attached_items/list-attached-items.md) +- Price variants + - [Price variant object](https://apidocs.chargebee.com/docs/api/price_variants/price-variant-object.md) + - [Create a price variant](https://apidocs.chargebee.com/docs/api/price_variants/create-a-price-variant.md) + - [Update a price variant](https://apidocs.chargebee.com/docs/api/price_variants/update-a-price-variant.md) + - [Retrieve a price variant](https://apidocs.chargebee.com/docs/api/price_variants/retrieve-a-price-variant.md) + - [List price variants](https://apidocs.chargebee.com/docs/api/price_variants/list-price-variants.md) + - [Delete a price variant](https://apidocs.chargebee.com/docs/api/price_variants/delete-a-price-variant.md) +- Differential prices + - [Differential price object](https://apidocs.chargebee.com/docs/api/differential_prices/differential-price-object.md) + - [Update a differential price](https://apidocs.chargebee.com/docs/api/differential_prices/update-a-differential-price.md) + - [Create a differential price](https://apidocs.chargebee.com/docs/api/differential_prices/create-a-differential-price.md) + - [Delete a differential price](https://apidocs.chargebee.com/docs/api/differential_prices/delete-a-differential-price.md) + - [Retrieve a differential price](https://apidocs.chargebee.com/docs/api/differential_prices/retrieve-a-differential-price.md) + - [List differential prices](https://apidocs.chargebee.com/docs/api/differential_prices/list-differential-prices.md) +- Coupons + - [Coupon object](https://apidocs.chargebee.com/docs/api/coupons/coupon-object.md) + - [Retrieve a coupon](https://apidocs.chargebee.com/docs/api/coupons/retrieve-a-coupon.md) + - [Create a coupon for items](https://apidocs.chargebee.com/docs/api/coupons/create-a-coupon-for-items.md) + - [Delete a coupon](https://apidocs.chargebee.com/docs/api/coupons/delete-a-coupon.md) + - [Update a coupon for items](https://apidocs.chargebee.com/docs/api/coupons/update-a-coupon-for-items.md) + - [Copy a coupon](https://apidocs.chargebee.com/docs/api/coupons/copy-a-coupon.md) + - [List coupons](https://apidocs.chargebee.com/docs/api/coupons/list-coupons.md) + - [Unarchive a coupon](https://apidocs.chargebee.com/docs/api/coupons/unarchive-a-coupon.md) +- Coupon sets + - [Coupon set object](https://apidocs.chargebee.com/docs/api/coupon_sets/coupon-set-object.md) + - [Retrieve a coupon set](https://apidocs.chargebee.com/docs/api/coupon_sets/retrieve-a-coupon-set.md) + - [Create a coupon set](https://apidocs.chargebee.com/docs/api/coupon_sets/create-a-coupon-set.md) + - [Update a coupon set](https://apidocs.chargebee.com/docs/api/coupon_sets/update-a-coupon-set.md) + - [Add coupon codes to coupon set](https://apidocs.chargebee.com/docs/api/coupon_sets/add-coupon-codes-to-coupon-set.md) + - [Delete a coupon set](https://apidocs.chargebee.com/docs/api/coupon_sets/delete-a-coupon-set.md) + - [List coupon sets](https://apidocs.chargebee.com/docs/api/coupon_sets/list-coupon-sets.md) + - [Delete unused coupon codes](https://apidocs.chargebee.com/docs/api/coupon_sets/delete-unused-coupon-codes.md) +- Coupon codes + - [Coupon code object](https://apidocs.chargebee.com/docs/api/coupon_codes/coupon-code-object.md) + - [List coupon codes](https://apidocs.chargebee.com/docs/api/coupon_codes/list-coupon-codes.md) + - [Retrieve a coupon code](https://apidocs.chargebee.com/docs/api/coupon_codes/retrieve-a-coupon-code.md) + - [Archive a coupon code](https://apidocs.chargebee.com/docs/api/coupon_codes/archive-a-coupon-code.md) +- [Using business entity filters in product catalog list APIs](https://apidocs.chargebee.com/docs/api/using_business_entity_filters_in_product_catalog_list_apis.md) + +# Offers + +- Personalized offers + - [Personalized offer object](https://apidocs.chargebee.com/docs/api/personalized_offers/personalized-offer-object.md) + - [List personalized offers](https://apidocs.chargebee.com/docs/api/personalized_offers/list-personalized-offers.md) +- Offer fulfillments + - [Offer fulfillment object](https://apidocs.chargebee.com/docs/api/offer_fulfillments/offer-fulfillment-object.md) + - [Create an offer fulfillment](https://apidocs.chargebee.com/docs/api/offer_fulfillments/create-an-offer-fulfillment.md) + - [Retrieve an offer fulfillment](https://apidocs.chargebee.com/docs/api/offer_fulfillments/retrieve-an-offer-fulfillment.md) + - [Update an offer fulfillment](https://apidocs.chargebee.com/docs/api/offer_fulfillments/update-an-offer-fulfillment.md) +- Offer events + - [Offer event object](https://apidocs.chargebee.com/docs/api/offer_events/offer-event-object.md) + - [Create an offer event](https://apidocs.chargebee.com/docs/api/offer_events/create-an-offer-event.md) + +# Entitlements + +- Features + - [Feature object](https://apidocs.chargebee.com/docs/api/features/feature-object.md) + - [Delete a feature](https://apidocs.chargebee.com/docs/api/features/delete-a-feature.md) + - [List features](https://apidocs.chargebee.com/docs/api/features/list-features.md) + - [Activate a feature](https://apidocs.chargebee.com/docs/api/features/activate-a-feature.md) + - [Create a feature](https://apidocs.chargebee.com/docs/api/features/create-a-feature.md) + - [Archive a feature](https://apidocs.chargebee.com/docs/api/features/archive-a-feature.md) + - [Update a feature](https://apidocs.chargebee.com/docs/api/features/update-a-feature.md) + - [Reactivate a feature](https://apidocs.chargebee.com/docs/api/features/reactivate-a-feature.md) + - [Retrieve a feature](https://apidocs.chargebee.com/docs/api/features/retrieve-a-feature.md) +- Entitlements + - [Entitlement object](https://apidocs.chargebee.com/docs/api/entitlements/entitlement-object.md) + - [Manage entitlements for a feature](https://apidocs.chargebee.com/docs/api/entitlements/upsert-or-remove-entitlements-for-a-feature.md) + - [List entitlements](https://apidocs.chargebee.com/docs/api/entitlements/list-all-entitlements.md) +- Item entitlements + - [Item entitlement object](https://apidocs.chargebee.com/docs/api/item_entitlements/item-entitlement-object.md) + - [Upsert or remove item entitlements for a feature](https://apidocs.chargebee.com/docs/api/item_entitlements/upsert-or-remove-item-entitlements-for-a-feature.md) + - [List item entitlements for an item](https://apidocs.chargebee.com/docs/api/item_entitlements/list-item-entitlements-for-an-item.md) + - [Upsert or remove item entitlements for an item](https://apidocs.chargebee.com/docs/api/item_entitlements/upsert-or-remove-item-entitlements-for-an-item.md) + - [List item entitlements for a feature](https://apidocs.chargebee.com/docs/api/item_entitlements/list-item-entitlements-for-a-feature.md) +- Customer entitlements + - [Customer entitlement object](https://apidocs.chargebee.com/docs/api/customer_entitlements/customer-entitlement-object.md) + - [List customer entitlements](https://apidocs.chargebee.com/docs/api/customer_entitlements/list-customer-entitlements.md) +- Subscription entitlements + - [Subscription entitlement object](https://apidocs.chargebee.com/docs/api/subscription_entitlements/subscription-entitlement-object.md) + - [Enable or disable subscription entitlements](https://apidocs.chargebee.com/docs/api/subscription_entitlements/enable-or-disable-subscription-entitlements.md) + - [List subscription entitlements](https://apidocs.chargebee.com/docs/api/subscription_entitlements/list-subscription-entitlements.md) +- Entitlement overrides + - [Entitlement override object](https://apidocs.chargebee.com/docs/api/entitlement_overrides/entitlement-override-object.md) + - [List entitlement overrides for a subscription](https://apidocs.chargebee.com/docs/api/entitlement_overrides/list-entitlement-overrides-for-a-subscription.md) + - [Upsert or remove entitlement overrides for a subscription](https://apidocs.chargebee.com/docs/api/entitlement_overrides/upsert-or-remove-entitlement-overrides-for-a-subscription.md) +- Impacted items + - [Impacted item object](https://apidocs.chargebee.com/docs/api/impacted_items/impacted-item-object.md) +- Impacted subscriptions + - [Impacted subscription object](https://apidocs.chargebee.com/docs/api/impacted_subscriptions/impacted-subscription-object.md) + +# Usage Based Billing + +- Usage events + - [Usage event object](https://apidocs.chargebee.com/docs/api/usage_events/v2-usage-object.md) + - [Ingest a usage event](https://apidocs.chargebee.com/docs/api/usage_events/create-a-usage-event.md) + - [Ingest usage events in batch](https://apidocs.chargebee.com/docs/api/usage_events/ingest-usages-in-batch.md) + - [Upload usage events using file](https://apidocs.chargebee.com/docs/api/usage_events/upload-usage-events-using-file.md) +- Usage files + - [Usage file object](https://apidocs.chargebee.com/docs/api/usage_files/usage-file-object.md) + - [Retrieve usage file upload URL](https://apidocs.chargebee.com/docs/api/usage_files/get-usages-file-upload-url.md) + - [Retrieve file processing status](https://apidocs.chargebee.com/docs/api/usage_files/get-uploaded-file-processing-status.md) + +# Hosted pages + +- Hosted pages + - [Hosted page object](https://apidocs.chargebee.com/docs/api/hosted_pages/hosted-page-object.md) + - [Extend Subscription](https://apidocs.chargebee.com/docs/api/hosted_pages/extend-subscription.md) + - [Checkout charge-items and one-time charges](https://apidocs.chargebee.com/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges.md) + - [Checkout Gift subscription for Items](https://apidocs.chargebee.com/docs/api/hosted_pages/checkout-gift-subscription-for-items.md) + - [Create checkout for a new subscription](https://apidocs.chargebee.com/docs/api/hosted_pages/create-checkout-for-a-new-subscription.md) + - [Claim a Gift subscription](https://apidocs.chargebee.com/docs/api/hosted_pages/claim-a-gift-subscription.md) + - [Create checkout to update a subscription](https://apidocs.chargebee.com/docs/api/hosted_pages/create-checkout-to-update-a-subscription.md) + - [Retrieve Direct Debit Agreement PDF](https://apidocs.chargebee.com/docs/api/hosted_pages/retrieve-direct-debit-agreement-pdf.md) + - [Update payment method](https://apidocs.chargebee.com/docs/api/hosted_pages/update-payment-method.md) + - [Acknowledge a hosted page](https://apidocs.chargebee.com/docs/api/hosted_pages/acknowledge-a-hosted-page.md) + - [Manage Payment Sources](https://apidocs.chargebee.com/docs/api/hosted_pages/manage-payment-sources.md) + - [Retrieve a hosted page](https://apidocs.chargebee.com/docs/api/hosted_pages/retrieve-a-hosted-page.md) + - [Collect Now](https://apidocs.chargebee.com/docs/api/hosted_pages/collect-now.md) + - [List hosted pages](https://apidocs.chargebee.com/docs/api/hosted_pages/list-hosted-pages.md) + - [Accept a quote](https://apidocs.chargebee.com/docs/api/hosted_pages/accept-a-quote.md) + - [Create a pre-cancel hosted page](https://apidocs.chargebee.com/docs/api/hosted_pages/create-a-pre-cancel-hosted-page.md) + - [Notify an event](https://apidocs.chargebee.com/docs/api/hosted_pages/notify-an-event.md) + - [Create a hosted page to view Boleto vouchers](https://apidocs.chargebee.com/docs/api/hosted_pages/create-a-hosted-page-to-view-boleto-vouchers.md) +- Portal sessions + - [Portal session object](https://apidocs.chargebee.com/docs/api/portal_sessions/portal-session-object.md) + - [Logout a portal session](https://apidocs.chargebee.com/docs/api/portal_sessions/logout-a-portal-session.md) + - [Create a portal session](https://apidocs.chargebee.com/docs/api/portal_sessions/create-a-portal-session.md) + - [Activate a portal session](https://apidocs.chargebee.com/docs/api/portal_sessions/activate-a-portal-session.md) + - [Retrieve a portal session](https://apidocs.chargebee.com/docs/api/portal_sessions/retrieve-a-portal-session.md) +- Pricing page sessions + - [Pricing page session object](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/pricing-page-session-object.md) + - [Create pricing page for new subscription](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-new-subscription.md) + - [Create pricing page for existing subscription](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-existing-subscription.md) +- [Chargebee JS](https://jsdocs.chargebee.com/) + +# Payments + +- Payment sources + - [Payment source object](https://apidocs.chargebee.com/docs/api/payment_sources/payment-source-object.md) + - [Update a bank account payment source](https://apidocs.chargebee.com/docs/api/payment_sources/update-a-bank-account-payment-source.md) + - [Create using gateway temporary token](https://apidocs.chargebee.com/docs/api/payment_sources/create-using-gateway-temporary-token.md) + - [Verify bank account payment source](https://apidocs.chargebee.com/docs/api/payment_sources/verify-bank-account-payment-source.md) + - [Create using permanent token](https://apidocs.chargebee.com/docs/api/payment_sources/create-using-permanent-token.md) + - [Retrieve a payment source](https://apidocs.chargebee.com/docs/api/payment_sources/retrieve-a-payment-source.md) + - [Create using Chargebee token](https://apidocs.chargebee.com/docs/api/payment_sources/create-using-chargebee-token.md) + - [List payment sources](https://apidocs.chargebee.com/docs/api/payment_sources/list-payment-sources.md) + - [Create using payment intent](https://apidocs.chargebee.com/docs/api/payment_sources/create-using-payment-intent.md) + - [Switch gateway account](https://apidocs.chargebee.com/docs/api/payment_sources/switch-gateway-account.md) + - [Create a card payment source](https://apidocs.chargebee.com/docs/api/payment_sources/create-a-card-payment-source.md) + - [Export payment source](https://apidocs.chargebee.com/docs/api/payment_sources/export-payment-source.md) + - [Create a bank account payment source](https://apidocs.chargebee.com/docs/api/payment_sources/create-a-bank-account-payment-source.md) + - [Create a voucher payment method](https://apidocs.chargebee.com/docs/api/payment_sources/create-a-voucher-payment-method.md) + - [Delete a payment source](https://apidocs.chargebee.com/docs/api/payment_sources/delete-a-payment-source.md) + - [Update a card payment source](https://apidocs.chargebee.com/docs/api/payment_sources/update-a-card-payment-source.md) + - [Local delete a payment source](https://apidocs.chargebee.com/docs/api/payment_sources/local-delete-a-payment-source.md) +- Payment intents + - [Payment intent object](https://apidocs.chargebee.com/docs/api/payment_intents/payment-intent-object.md) + - [Update a payment intent](https://apidocs.chargebee.com/docs/api/payment_intents/update-a-payment-intent.md) + - [Create a payment intent](https://apidocs.chargebee.com/docs/api/payment_intents/create-a-payment-intent.md) + - [Retrieve a payment intent](https://apidocs.chargebee.com/docs/api/payment_intents/retrieve-a-payment-intent.md) +- Cards + - [Card object](https://apidocs.chargebee.com/docs/api/cards/card-object.md) + - [Switch gateway](https://apidocs.chargebee.com/docs/api/cards/switch-gateway.md) + - [Retrieve card for a customer](https://apidocs.chargebee.com/docs/api/cards/retrieve-card-for-a-customer.md) + - [Copy card](https://apidocs.chargebee.com/docs/api/cards/copy-card.md) + - [Update card for a customer](https://apidocs.chargebee.com/docs/api/cards/update-card-for-a-customer.md) + - [Delete card for a customer](https://apidocs.chargebee.com/docs/api/cards/delete-card-for-a-customer.md) +- Virtual bank accounts + - [Virtual bank account object](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts/virtual-bank-account-object.md) + - [List virtual bank accounts](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts/list-virtual-bank-accounts.md) + - [Create a virtual bank account using permanent token](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts/create-a-virtual-bank-account-using-permanent-token.md) + - [Delete a virtual bank account](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts/delete-a-virtual-bank-account.md) + - [Create a virtual bank account](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts/create-a-virtual-bank-account.md) + - [Local delete a virtual bank account](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts/local-delete-a-virtual-bank-account.md) + - [Retrieve a virtual bank account](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts/retrieve-a-virtual-bank-account.md) +- Transactions + - [Transaction object](https://apidocs.chargebee.com/docs/api/transactions/transaction-object.md) + - [Refund a payment](https://apidocs.chargebee.com/docs/api/transactions/refund-a-payment.md) + - [Create an authorization payment](https://apidocs.chargebee.com/docs/api/transactions/create-an-authorization-payment.md) + - [List transactions](https://apidocs.chargebee.com/docs/api/transactions/list-transactions.md) + - [Reconcile transaction](https://apidocs.chargebee.com/docs/api/transactions/reconcile-transaction.md) + - [Void an authorization transaction](https://apidocs.chargebee.com/docs/api/transactions/void-an-authorization-transaction.md) + - [List payments for an invoice](https://apidocs.chargebee.com/docs/api/transactions/list-payments-for-an-invoice.md) + - [Retrieve a transaction](https://apidocs.chargebee.com/docs/api/transactions/retrieve-a-transaction.md) + - [Record an offline refund](https://apidocs.chargebee.com/docs/api/transactions/record-an-offline-refund.md) + - [Delete an offline transaction](https://apidocs.chargebee.com/docs/api/transactions/delete-an-offline-transaction.md) +- Payment vouchers + - [Payment voucher object](https://apidocs.chargebee.com/docs/api/payment_vouchers/payment-voucher-object.md) + - [Create a voucher for the customer to initiate payment](https://apidocs.chargebee.com/docs/api/payment_vouchers/create-a-voucher-for-the-customer-to-initiate-payment.md) + - [List vouchers for a customer](https://apidocs.chargebee.com/docs/api/payment_vouchers/list-vouchers-for-a-customer.md) + - [List vouchers for an invoice](https://apidocs.chargebee.com/docs/api/payment_vouchers/list-vouchers-for-an-invoice.md) + - [Retrieve voucher data](https://apidocs.chargebee.com/docs/api/payment_vouchers/retrieve-voucher-data.md) +- [3DS card payments](https://apidocs.chargebee.com/docs/api/3ds_card_payments.md) +- [Payment parameters](https://apidocs.chargebee.com/docs/api/payment_parameters.md) +- [Gateway error references](https://apidocs.chargebee.com/docs/api/gateway_error_references.md) + +# Currencies + +- [Currency object](https://apidocs.chargebee.com/docs/api/currencies/currency-object.md) +- [Add a new currency](https://apidocs.chargebee.com/docs/api/currencies/add-a-new-currency.md) +- [Add schedule](https://apidocs.chargebee.com/docs/api/currencies/add-schedule.md) +- [Update a currency](https://apidocs.chargebee.com/docs/api/currencies/update-a-currency.md) +- [Retrieve a currency](https://apidocs.chargebee.com/docs/api/currencies/retrieve-a-currency.md) +- [List currencies](https://apidocs.chargebee.com/docs/api/currencies/list-currencies.md) +- [Remove schedule](https://apidocs.chargebee.com/docs/api/currencies/remove-schedule.md) + +# Events + +- Events + - [Event object](https://apidocs.chargebee.com/docs/api/events/event-object.md) + - [Event types](https://apidocs.chargebee.com/docs/api/events/event-types.md) + - [Retrieve an event](https://apidocs.chargebee.com/docs/api/events/retrieve-an-event.md) + - [List events](https://apidocs.chargebee.com/docs/api/events/list-events.md) +- Webhook Endpoints + - [Webhook endpoint object](https://apidocs.chargebee.com/docs/api/webhook_endpoints/webhook-endpoint-object.md) + - [List webhook endpoints](https://apidocs.chargebee.com/docs/api/webhook_endpoints/list-webhook-endpoints.md) + - [Retrieve a webhook endpoint](https://apidocs.chargebee.com/docs/api/webhook_endpoints/retrieve-a-webhook-endpoint.md) + - [Create a webhook endpoint](https://apidocs.chargebee.com/docs/api/webhook_endpoints/create-a-webhook-endpoint.md) + - [Update webhook endpoint](https://apidocs.chargebee.com/docs/api/webhook_endpoints/update-a-webhook-endpoint.md) + - [Delete a webhook endpoint](https://apidocs.chargebee.com/docs/api/webhook_endpoints/delete-a-webhook-endpoint.md) + +# Exports + +- Exports + - [Export object](https://apidocs.chargebee.com/docs/api/exports/export-object.md) + - [Export Credit Notes](https://apidocs.chargebee.com/docs/api/exports/export-credit-notes.md) + - [Retrieve an export](https://apidocs.chargebee.com/docs/api/exports/retrieve-an-export.md) + - [Export Transactions](https://apidocs.chargebee.com/docs/api/exports/export-transactions.md) + - [Export Revenue Recognition Reports](https://apidocs.chargebee.com/docs/api/exports/export-revenue-recognition-reports.md) + - [Export Orders](https://apidocs.chargebee.com/docs/api/exports/export-orders.md) + - [Export Deferred Revenue Reports](https://apidocs.chargebee.com/docs/api/exports/export-deferred-revenue-reports.md) + - [Export Item Families](https://apidocs.chargebee.com/docs/api/exports/export-item-families.md) + - [Export Coupons](https://apidocs.chargebee.com/docs/api/exports/export-coupons.md) + - [Export Items](https://apidocs.chargebee.com/docs/api/exports/export-items.md) + - [Export Customers](https://apidocs.chargebee.com/docs/api/exports/export-customers.md) + - [Export Item Prices](https://apidocs.chargebee.com/docs/api/exports/export-item-prices.md) + - [Export Subscriptions](https://apidocs.chargebee.com/docs/api/exports/export-subscriptions.md) + - [Export Attached Items](https://apidocs.chargebee.com/docs/api/exports/export-attached-items.md) + - [Export Invoices](https://apidocs.chargebee.com/docs/api/exports/export-invoices.md) + - [Export Differential Price](https://apidocs.chargebee.com/docs/api/exports/export-differential-price.md) + - [Export Price Variants](https://apidocs.chargebee.com/docs/api/exports/export-price-variants.md) +- Downloads + - [Download object](https://apidocs.chargebee.com/docs/api/downloads/download-object.md) + +# Simulation Tools + +- [Time machine object](https://apidocs.chargebee.com/docs/api/time_machines/time-machine-object.md) +- [Start Afresh](https://apidocs.chargebee.com/docs/api/time_machines/start-afresh.md) +- [Retrieve a time machine](https://apidocs.chargebee.com/docs/api/time_machines/retrieve-a-time-machine.md) +- [Travel forward](https://apidocs.chargebee.com/docs/api/time_machines/travel-forward.md) + +# More Resources + +- Comments + - [Comment object](https://apidocs.chargebee.com/docs/api/comments/comment-object.md) + - [List comments](https://apidocs.chargebee.com/docs/api/comments/list-comments.md) + - [Create a comment](https://apidocs.chargebee.com/docs/api/comments/create-a-comment.md) + - [Delete a comment](https://apidocs.chargebee.com/docs/api/comments/delete-a-comment.md) + - [Retrieve a comment](https://apidocs.chargebee.com/docs/api/comments/retrieve-a-comment.md) +- Site migration details + - [Site migration detail object](https://apidocs.chargebee.com/docs/api/site_migration_details/site-migration-detail-object.md) + - [List site migration details](https://apidocs.chargebee.com/docs/api/site_migration_details/list-site-migration-details.md) +- Configurations + - [Configuration object](https://apidocs.chargebee.com/docs/api/configurations/configuration-object.md) + - [List site configurations](https://apidocs.chargebee.com/docs/api/configurations/list-site-configurations.md) +- [Upgrade to Product Catalog 2.0](https://apidocs.chargebee.com/docs/api/upgrade.md) +- [Errors](https://apidocs.chargebee.com/docs/api/errors.md) +- [Chargebee root and intermediate CA certificate updates](https://apidocs.chargebee.com/docs/api/tls_certificate_update_g2.md) diff --git a/skills/chargebee-integration/references/errors.md b/skills/chargebee-integration/references/errors.md new file mode 100644 index 0000000..b5f632a --- /dev/null +++ b/skills/chargebee-integration/references/errors.md @@ -0,0 +1,217 @@ +# Errors + +Details of specific error codes, along with the root cause and possible solutions are listed below + +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_activity_exceeded.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_b2b_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_blocked.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_closed.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_config.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_currency_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_declined.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_frozen.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_holder_deceased.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_restricted.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_unusable.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.account_unverified.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.country_not_supported.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.invalid_account_number.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.invalid_iban.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.invalid_merchant_id.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.invalid_owner_name.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.live_not_permitted.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.no_account.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.sepa_not_supported.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.setup_amount.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.setup_hierarchy.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.bank_account.test_only.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.compliance.creditor_name_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.compliance.invalid_account_details.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.compliance.invalid_account_number.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.compliance.regulatory_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.compliance.unauthorized_debit.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.dispute.cannot_refund.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.dispute.charge_disputed.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.dispute.charge_not_refundable.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.dispute.currency_mismatch.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.dispute.debit_disputed.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.fraud.account_fraud.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.fraud.acquirer_counterfeit.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.fraud.card_fraud.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.fraud.identified.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.fraud.illegal_transaction.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.fraud.security_violation.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.fraud.suspected_fraud.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.general.could_not_process.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.general.decline.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.general.failure.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.general.not_supported.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.general.unknown.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.identity_verification.3ds_authentication_failure.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.identity_verification.additional_auth_required.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.identity_verification.authentication_required.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.identity_verification.cardholder_kyc_failure.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.identity_verification.contact_details_required.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.identity_verification.contactless_fallback.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.identity_verification.invalid_pin_lock.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.identity_verification.invalid_user_cred.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.identity_verification.not_found.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.identity_verification.pin_required.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.mandate.billing_agreement_cancelled.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.mandate.billing_agreement_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.mandate.mandate_incorrect.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.mandate.recurring_exceeded_limit.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.merchant_account.authentication_failure.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.merchant_account.authentication_required.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.merchant_account.cannot_process_live.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.merchant_account.country_not_supported.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.merchant_account.currency_not_supported.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.merchant_account.invalid_credentials.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.merchant_account.invalid_merchant.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.merchant_account.only_test_charges_allowed.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.merchant_account.payment_method_not_supported.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.merchant_account.setup_merchant.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.merchant_account.test_only.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_barred.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_blocked.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_currency_not_supported.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_cvv_disabled.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_deactivated.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_expired.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_inactive.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_incorrect_cvv.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_incorrect_number.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_incorrect_zip.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_invalid_expiry.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_invalid_number.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_limit_exceeded.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_lost.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_not_activated.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_number_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_pin_invalid.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_pin_retries_exceeded.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_purchase_type_not_supported.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_revoked.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_suspended.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_temp_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.card_type_not_supported.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.config.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.gift_card_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.gift_card_tag_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.invalid.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.invalid_format.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.not_found.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.not_supported.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.paypal_validation_failed.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.setup_card.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.unactivated.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.payment_method.unexpected_state.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.acquirer_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.bank_account_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.could_not_process.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.encryption_error.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.inconsistent_data.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.invalid_creditor_info.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.invalid_order_id.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.invalid_request_encoding.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.invalid_request_error.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.invalid_transaction.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.invalid_transaction_code.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.issuer_inoperative.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.issuer_invalid.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.issuer_not_found.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.issuer_offline.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.issuer_unavailable.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.missing_data.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.network_downtime.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.processor_feature_unavailable.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.processor_network_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.rate_limit_exceeded.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.server_error.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.temporary_processing_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.timeout.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.technical.unauthorized.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.token.token_in_use.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.already_captured.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.auth_already_reversed.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.auth_code_invalid.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.auth_expired.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.auth_not_found.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.authorization_revoked.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.card_capture.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.card_restrictions.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.debit_authorization_revoked.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.debit_authorization_stopped.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.debit_not_authorized.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.declined.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.do_not_honor.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.do_not_retry.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.payment_stopped.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.pre_authorization_failure.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.temp_auth_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.unauthorized_debit.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_authorization.voice_auth_required.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.address_not_matching.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.amount_invalid.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.amount_mismatch.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.amount_too_large.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.amount_too_small.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.avs_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.bin_invalid.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.card_declined.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.cardholder_billing_stop.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.charge_already_refunded.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.charge_exceeds_source_limit.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.charge_invalid_parameter.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.charge_not_refundable.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.could_not_process.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.decline_rate_limit_exceeded.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.duplicate_transaction.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.gift_no_balance.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.incorrect_processing.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.insufficient_funds.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.invalid_account_number.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.invalid_address.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.invalid_config.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.invalid_currency.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.invalid_level3_data.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.invalid_status.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.invalid_transaction.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.low_balance.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.network_decline.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.no_universal_account.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.not_permitted.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.odfi_returned.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.over_max_balance.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.partial_refund_declined.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.payment_attempt_failed.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.payment_code_incorrect.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.payment_intent_attempt_failed.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.payment_intent_invalid.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.payment_intent_mandate_inactive.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.payment_intent_unexpected_state.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.payment_method_not_available.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.payment_method_not_found.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.payment_type_mismatch.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.pickup_card_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.pickup_card_lost.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.processor_feature_unsupported.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.recurring_payment_mandate_canceled.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.refer_to_customer.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.refund_declined.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.refund_limit_exceeded.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.refund_not_issued.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.refund_timelimit_exceeded.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.refund_window_crossed.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.resource_missing.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.surcharge_not_permitted.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.temp_not_allowed.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.temporary_issue.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.transaction_expired.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.transaction_not_allowed.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.transaction_not_permitted_to_cardholder.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.transaction_rejected.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.unauthorized_debit.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.withdrawal_frequency_exceeded.md +- https://apidocs.chargebee.com/docs/api/errors/gateway.transaction_processing.withdrawal_limit_exceede.md diff --git a/skills/chargebee-integration/references/events.md b/skills/chargebee-integration/references/events.md new file mode 100644 index 0000000..bed3fc4 --- /dev/null +++ b/skills/chargebee-integration/references/events.md @@ -0,0 +1,220 @@ +# Webhook Events + +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_pause_scheduled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/customer_business_entity_changed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_advance_invoice_schedule_added.md +- https://apidocs.chargebee.com/docs/api/events/webhook/gift_expired.md +- https://apidocs.chargebee.com/docs/api/events/webhook/tax_withheld_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/unbilled_charges_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/coupon_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/product_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_reactivated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_renewed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/unbilled_charges_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_resumed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_one_time_order_item_cancelled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_cancelled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_entitlements_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/business_entity_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/coupon_set_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/differential_price_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_paused.md +- https://apidocs.chargebee.com/docs/api/events/webhook/entitlement_overrides_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_activated_with_backdating.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_trial_end_reminder.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_shipping_address_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/voucher_create_failed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/gift_claimed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/customer_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/refund_initiated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/invoice_generated_with_backdating.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_transaction_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/add_usages_reminder.md +- https://apidocs.chargebee.com/docs/api/events/webhook/voucher_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/rule_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_schedules_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/feature_activated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_source_locally_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/invoice_generated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/voucher_expired.md +- https://apidocs.chargebee.com/docs/api/events/webhook/authorization_succeeded.md +- https://apidocs.chargebee.com/docs/api/events/webhook/gift_scheduled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_changes_scheduled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_changed_with_backdating.md +- https://apidocs.chargebee.com/docs/api/events/webhook/variant_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_changed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/gift_unclaimed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/virtual_bank_account_added.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_intent_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/credit_note_created_with_backdating.md +- https://apidocs.chargebee.com/docs/api/events/webhook/contract_term_terminated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_family_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/order_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/price_variant_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_movement_failed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/customer_moved_in.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_advance_invoice_schedule_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_ramp_drafted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/dunning_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_entitlements_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/token_consumed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/hierarchy_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_cancellation_scheduled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_renewed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/feature_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/feature_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_family_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_scheduled_change_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_resumed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/purchase_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/entitlement_overrides_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_family_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_resumption_scheduled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/feature_reactivated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/coupon_codes_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/card_expired.md +- https://apidocs.chargebee.com/docs/api/events/webhook/credit_note_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_downgraded.md +- https://apidocs.chargebee.com/docs/api/events/webhook/price_variant_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/promotional_credits_deducted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_ramp_applied.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_paused.md +- https://apidocs.chargebee.com/docs/api/events/webhook/order_ready_to_process.md +- https://apidocs.chargebee.com/docs/api/events/webhook/feature_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/transaction_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/credit_note_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_resubscribed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/record_purchase_failed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/transaction_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/variant_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/mrr_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/unbilled_charges_invoiced.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_price_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/coupon_codes_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/virtual_bank_account_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/contract_term_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_changed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_failed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/credit_note_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/tax_withheld_refunded.md +- https://apidocs.chargebee.com/docs/api/events/webhook/contract_term_completed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_schedules_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_expired.md +- https://apidocs.chargebee.com/docs/api/events/webhook/card_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/customer_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_renewal_reminder.md +- https://apidocs.chargebee.com/docs/api/events/webhook/netd_payment_due_reminder.md +- https://apidocs.chargebee.com/docs/api/events/webhook/order_delivered.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_cancellation_scheduled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_grace_period_expired.md +- https://apidocs.chargebee.com/docs/api/events/webhook/coupon_codes_added.md +- https://apidocs.chargebee.com/docs/api/events/webhook/gift_cancelled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/order_cancelled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/coupon_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_scheduled_changes_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/pending_invoice_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/product_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/entitlement_overrides_auto_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_upgraded.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_business_entity_changed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_one_time_order_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_source_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_cancelled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/quote_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/invoice_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_advance_invoice_schedule_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/card_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/order_ready_to_ship.md +- https://apidocs.chargebee.com/docs/api/events/webhook/variant_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_moved_out.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_schedule_scheme_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/business_entity_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_scheduled_resumption_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_initiated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/feature_archived.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_reactivated_with_backdating.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_imported.md +- https://apidocs.chargebee.com/docs/api/events/webhook/token_expired.md +- https://apidocs.chargebee.com/docs/api/events/webhook/card_added.md +- https://apidocs.chargebee.com/docs/api/events/webhook/coupon_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/rule_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_price_entitlements_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_price_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/virtual_bank_account_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_schedule_scheme_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_entitlements_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/order_returned.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_source_added.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_moved_in.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_price_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_scheduled_cancellation_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_refunded.md +- https://apidocs.chargebee.com/docs/api/events/webhook/usage_file_ingested.md +- https://apidocs.chargebee.com/docs/api/events/webhook/product_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_moved_in.md +- https://apidocs.chargebee.com/docs/api/events/webhook/differential_price_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/transaction_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_downgrade_scheduled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_succeeded.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_canceled_with_backdating.md +- https://apidocs.chargebee.com/docs/api/events/webhook/unbilled_charges_voided.md +- https://apidocs.chargebee.com/docs/api/events/webhook/quote_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/coupon_set_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/attached_item_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/sales_order_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/customer_changed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_started.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_activated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_source_expiring.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_reactivated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/order_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_scheduled_pause_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_cancellation_reminder.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_created_with_backdating.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_ramp_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/order_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_pause_scheduled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/gift_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_trial_extended.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_grace_period_started.md +- https://apidocs.chargebee.com/docs/api/events/webhook/card_expiry_reminder.md +- https://apidocs.chargebee.com/docs/api/events/webhook/token_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/promotional_credits_added.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_ramp_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/customer_entitlements_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_source_expired.md +- https://apidocs.chargebee.com/docs/api/events/webhook/customer_moved_out.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_entitlements_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_dunning_expired.md +- https://apidocs.chargebee.com/docs/api/events/webhook/hierarchy_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/attached_item_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_scheduled_cancellation_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/coupon_set_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_intent_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/order_resent.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_scheduled_downgrade_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/tax_withheld_recorded.md +- https://apidocs.chargebee.com/docs/api/events/webhook/price_variant_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/differential_price_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_items_renewed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/rule_created.md +- https://apidocs.chargebee.com/docs/api/events/webhook/contract_term_cancelled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/contract_term_renewed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/invoice_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/item_price_entitlements_removed.md +- https://apidocs.chargebee.com/docs/api/events/webhook/sales_order_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_dunning_started.md +- https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_change_scheduled.md +- https://apidocs.chargebee.com/docs/api/events/webhook/pending_invoice_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/quote_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/attached_item_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/payment_source_updated.md +- https://apidocs.chargebee.com/docs/api/events/webhook/business_entity_deleted.md +- https://apidocs.chargebee.com/docs/api/events/webhook/authorization_voided.md +- https://apidocs.chargebee.com/docs/api/events/webhook/subscription_ramp_delete.md diff --git a/skills/chargebee-integration/references/rest-api.md b/skills/chargebee-integration/references/rest-api.md new file mode 100644 index 0000000..23d001d --- /dev/null +++ b/skills/chargebee-integration/references/rest-api.md @@ -0,0 +1,331 @@ +# Chargebee API Reference + +## Authentication + +All API requests require Basic Authentication with your API key: + +``` +Authorization: Basic +``` + +Base URL: `https://[your-site].chargebee.com/api/v2` + +## HTTP Methods + +- **GET**: Read-only operations (retrieve, list) +- **POST**: Write operations (create, update, delete) + +## Request and Response format + +A majority of the API endpoints expect the request to be of type `application/x-www-form-urlencoded`. Nested objects are expected to conform to the commonly used **extended** URL encoding pattern. For example, a JSON request and it's equivalent URL encoded `curl` request is shown below: + +JSON: + +```json +{ + "customer": { + "first_name": "John", + "last_name": "Doe", + "allow_direct_debit": true, + "bank_account": { + "account_number": "000222222227", + "bank_name": "US Bank", + "account_type": "savings" + } + } +} +``` + +URL Encoded: + +```bash +curl https://{CHARGEBEE_SITE}.chargebee.com/api/v2/customers \ + -X POST \ + -u {site_api_key}:\ + -d "first_name"="John" \ + -d "last_name"="Doe" \ + -d "allow_direct_debit"="true" \ + -d "bank_account[account_number]"=000222222227 \ + -d "bank_account[routing_number]"=110000000 \ + -d "bank_account[bank_name]"="US Bank" \ + -d "bank_account[account_type]"="savings" +``` + +All responses are of type `application/json`. + +## Core Resources + +### Customers + +**Create Customer** +``` +POST /customers +``` +Body parameters: +- `id` (optional): Custom customer identifier +- `first_name`: Customer first name +- `last_name`: Customer last name +- `email`: Contact email +- `phone`: Phone number +- `company`: Company name +- `auto_collection`: on/off (payment automation) +- `billing_address`: Address object + +**Retrieve Customer** +``` +GET /customers/{customer-id} +``` + +**Update Customer** +``` +POST /customers/{customer-id} +``` +Accepts same parameters as create (updates specified fields only) + +**List Customers** +``` +GET /customers +``` +Query parameters: +- `limit`: Results per page (default 10, max 100) +- `offset`: Pagination offset +- `email[is]`: Filter by email +- `created_at[after]`: Filter by creation date + +**Delete Customer** +``` +POST /customers/{customer-id}/delete +``` + +### Subscriptions + +**Create Subscription** +``` +POST /subscriptions +``` +Body parameters: +- `plan_id`: The plan identifier +- `customer_id`: Existing customer ID +- `billing_cycles`: Number of billing cycles +- `trial_end`: Trial end timestamp +- `auto_collection`: on/off +- `addons`: Array of addon objects + +**Retrieve Subscription** +``` +GET /subscriptions/{subscription-id} +``` + +**Update Subscription** +``` +POST /subscriptions/{subscription-id} +``` + +**Cancel Subscription** +``` +POST /subscriptions/{subscription-id}/cancel +``` +Parameters: +- `end_of_term`: true/false (cancel immediately or at term end) + +**Reactivate Subscription** +``` +POST /subscriptions/{subscription-id}/reactivate +``` + +**List Subscriptions** +``` +GET /subscriptions +``` +Query parameters: +- `customer_id[is]`: Filter by customer +- `status[is]`: active/cancelled/non_renewing/in_trial +- `limit`, `offset`: Pagination + +### Invoices + +**Create Invoice** +``` +POST /invoices +``` + +**Retrieve Invoice** +``` +GET /invoices/{invoice-id} +``` + +**List Invoices** +``` +GET /invoices +``` +Query parameters: +- `customer_id[is]`: Filter by customer +- `status[is]`: paid/posted/payment_due/not_paid +- `date[after]`, `date[before]`: Date filters + +**Void Invoice** +``` +POST /invoices/{invoice-id}/void +``` + +**Collect Payment** +``` +POST /invoices/{invoice-id}/collect_payment +``` + +### Payment Sources + +**Create Payment Source** +``` +POST /customers/{customer-id}/payment_sources +``` +Parameters: +- `type`: card/bank_account/paypal +- `gateway_account_id`: Payment gateway identifier +- Card/bank details as needed + +**Retrieve Payment Source** +``` +GET /payment_sources/{payment-source-id} +``` + +**Delete Payment Source** +``` +POST /payment_sources/{payment-source-id}/delete +``` + +### Plans + +**Create Plan** +``` +POST /plans +``` +Body parameters: +- `id`: Plan identifier +- `name`: Plan display name +- `price`: Plan price in cents +- `period`: Billing period (day/week/month/year) +- `period_unit`: Number of periods + +**Retrieve Plan** +``` +GET /plans/{plan-id} +``` + +**List Plans** +``` +GET /plans +``` + +**Update Plan** +``` +POST /plans/{plan-id} +``` + +### Addons + +**Create Addon** +``` +POST /addons +``` + +**Retrieve Addon** +``` +GET /addons/{addon-id} +``` + +**List Addons** +``` +GET /addons +``` + +### Transactions + +**List Transactions** +``` +GET /transactions +``` +Query parameters: +- `customer_id[is]`: Filter by customer +- `subscription_id[is]`: Filter by subscription +- `date[after]`, `date[before]`: Date range + +**Retrieve Transaction** +``` +GET /transactions/{transaction-id} +``` + +## Common Response Structure + +Successful responses contain the requested resource(s): + +```json +{ + "customer": { + "id": "cust_123", + "first_name": "John", + "last_name": "Doe", + "email": "john@example.com", + // ... more fields + } +} +``` + +List responses include pagination: + +```json +{ + "list": [ + { "customer": { /* ... */ } }, + { "customer": { /* ... */ } } + ], + "next_offset": "[encoded-offset]" +} +``` + +## Error Responses + +Errors return appropriate HTTP status codes with error details: + +```json +{ + "message": "Error message", + "type": "invalid_request", + "api_error_code": "resource_not_found" +} +``` + +Common error codes: +- `payment_processing_failed` +- `resource_not_found` +- `invalid_request` +- `operation_failed` + +## Pagination + +Use `limit` and `offset` for pagination: + +``` +GET /customers?limit=10&offset=[encoded-offset] +``` + +The response includes `next_offset` for fetching the next page. + +## Filters + +Most list endpoints support filtering: + +``` +GET /subscriptions?status[is]=active&customer_id[is]=cust_123 +``` + +Available filter operators: +- `[is]`: Exact match +- `[is_not]`: Not equal +- `[in]`: In array (comma-separated) +- `[after]`, `[before]`: Date comparisons +- `[starts_with]`: String prefix matching + +## Rate Limiting + +Chargebee enforces rate limits per site. Respect `Retry-After` headers in 429 responses. diff --git a/skills/chargebee-integration/references/webhooks.md b/skills/chargebee-integration/references/webhooks.md new file mode 100644 index 0000000..9ee8c32 --- /dev/null +++ b/skills/chargebee-integration/references/webhooks.md @@ -0,0 +1,285 @@ +# Chargebee Webhook Events + +## Overview + +Chargebee sends webhook notifications for important billing events. Webhooks are asynchronous and may: +- Arrive out of order +- Be delivered multiple times +- Include a delay between the actual event and delivery + +**Best practices:** +- Verify webhook signatures +- Implement idempotency using `event.id` +- Return 200 OK quickly (process asynchronously) +- Handle all event types gracefully + +## Webhook Payload Structure + +```json +{ + "id": "ev_123", + "occurred_at": 1234567890, + "source": "admin_console", + "event_type": "customer_created", + "webhook_status": "scheduled", + "content": { + "customer": { + "id": "cust_123", + // ... customer object fields + } + } +} +``` + +## Customer Events + +### customer_created +Triggered when a new customer is created, either independently or during subscription creation. + +**Content**: `customer` object + +### customer_changed +Fired when customer information is modified. + +**Content**: `customer` object + +### customer_deleted +Sent when a customer is deleted from the system. + +**Content**: `customer` object (with deleted state) + +### customer_moved_out +Triggered when a customer is copied to another Chargebee site. + +**Content**: `customer` object + +### customer_moved_in +Fired when a customer is copied from another Chargebee site. + +**Content**: `customer` object + +### promotional_credits_added +Sent when promotional credits are added to a customer account. + +**Content**: `customer` object, `promotional_credits` object + +### promotional_credits_deducted +Triggered when promotional credits are removed from an account. + +**Content**: `customer` object, `promotional_credits` object + +## Subscription Events + +### subscription_created +Sent when a new subscription is established. + +**Content**: `subscription` object, `customer` object + +### subscription_created_with_backdating +Fired when subscription creation includes backdated changes. + +**Content**: `subscription` object, `customer` object + +### subscription_started +Triggered when a future subscription begins at the scheduled start date. + +**Content**: `subscription` object, `customer` object + +### subscription_trial_end_reminder +Sent as the trial period approaches completion (typically 3 days before). + +**Content**: `subscription` object, `customer` object + +### subscription_activated +Fired when a subscription transitions from trial to active state. + +**Content**: `subscription` object, `customer` object + +### subscription_changed +Activated when subscription items (plans, addons, quantities) are modified. + +**Content**: `subscription` object, `customer` object + +### subscription_trial_extended +Sent when the trial period is extended. + +**Content**: `subscription` object, `customer` object + +### subscription_renewed +Triggered when a subscription renews for a new term. + +**Content**: `subscription` object, `customer` object, `invoice` object + +### subscription_paused +Sent when a subscription is paused. + +**Content**: `subscription` object, `customer` object + +### subscription_resumed +Triggered when a paused subscription resumes. + +**Content**: `subscription` object, `customer` object + +### subscription_cancelled +Fired when a subscription is cancelled. + +**Content**: `subscription` object, `customer` object + +### subscription_reactivated +Sent when a cancelled subscription returns to active or trial state. + +**Content**: `subscription` object, `customer` object + +### subscription_deleted +Triggered when a subscription is permanently deleted. + +**Content**: `subscription` object, `customer` object + +## Invoice Events + +### invoice_generated +Fired when an invoice is created (draft or posted). + +**Content**: `invoice` object, `customer` object + +### invoice_updated +Sent when invoice details are modified. + +**Content**: `invoice` object, `customer` object + +### invoice_deleted +Triggered when an invoice is deleted. + +**Content**: `invoice` object, `customer` object + +## Payment Events + +### payment_succeeded +Sent when a payment is successfully processed. + +**Content**: `transaction` object, `customer` object, `invoice` object + +### payment_failed +Triggered when a payment attempt fails. + +**Content**: `transaction` object, `customer` object, `invoice` object + +### payment_refunded +Fired when a refund is issued. + +**Content**: `transaction` object, `customer` object, `invoice` object + +### payment_source_added +Sent when a payment method is added to a customer. + +**Content**: `payment_source` object, `customer` object + +### payment_source_updated +Triggered when payment source details are modified. + +**Content**: `payment_source` object, `customer` object + +### payment_source_deleted +Fired when a payment method is removed. + +**Content**: `payment_source` object, `customer` object + +## Coupon/Offer Events + +### coupon_created +Sent when a new coupon is created. + +**Content**: `coupon` object + +### coupon_updated +Triggered when coupon details are modified. + +**Content**: `coupon` object + +### coupon_deleted +Fired when a coupon is deleted. + +**Content**: `coupon` object + +### coupon_set_created +Sent when a coupon set is created. + +**Content**: `coupon_set` object + +### coupon_set_updated +Triggered when a coupon set is modified. + +**Content**: `coupon_set` object + +### coupon_set_deleted +Fired when a coupon set is deleted. + +**Content**: `coupon_set` object + +### coupon_codes_added +Sent when individual coupon codes are added. + +**Content**: `coupon_code` objects + +### coupon_codes_updated +Triggered when coupon codes are modified. + +**Content**: `coupon_code` objects + +### coupon_codes_deleted +Fired when coupon codes are removed. + +**Content**: `coupon_code` objects + +## Billing Events + +### mrr_updated +Sent when Monthly Recurring Revenue (MRR) or committed MRR changes. + +**Content**: `mrr` object, `subscription` object, `customer` object + +## Webhook Verification + +Verify webhook authenticity using the signature header: + +```python +import chargebee + +def verify_webhook(payload, signature): + try: + chargebee.Webhook.verify_signature(payload, signature) + return True + except Exception as e: + return False +``` + +The signature is sent in the `X-Chargebee-Signature` header. + +## Idempotency + +Always check `event.id` to avoid processing duplicate webhooks: + +```python +processed_events = set() # Or use a database + +def handle_webhook(event): + event_id = event['id'] + + if event_id in processed_events: + return # Already processed + + # Process event + process_event(event) + + # Mark as processed + processed_events.add(event_id) +``` + +## Retry Behavior + +Chargebee retries failed webhooks (non-200 responses) with exponential backoff: +- First retry: After 5 minutes +- Subsequent retries: Increasing intervals +- Maximum retries: Continues for up to 3 days + +Return 200 OK to acknowledge successful receipt.