Articles in this section

Available Chargebee APIs

When you configure an export, import, other type of flow step using the prebuilt Chargebee connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Chargebee API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Addresses

Retrieve an address

X

Update an address

X

Attached items

Delete an attached item

X

Retrieve an attached item

X

Update an attached item

X

Batch

Ingest usage events in batch

X

Business entities

List business entity transfers

X

Transfer a customer to another business entity

X

Cards

Retrieve card for a customer

X

Comments

Create a comment

X

Delete a comment

X

List comments

X

Retrieve a comment

X

Configurations

List site configurations

X

Coupon codes

Archive a coupon code

X

List coupon codes

X

Retrieve a coupon code

X

Coupon sets

Add coupon codes to coupon set

X

Create a coupon set

X

Delete a coupon set

X

Delete unused coupon codes

X

List coupon sets

X

Retrieve a coupon set

X

Update a coupon set

X

Coupons

Copy a coupon

X

Create a coupon for items

X

Delete a coupon

X

List coupons

X

Retrieve a coupon

X

Unarchive a coupon

X

Update a coupon for items

X

Credit notes

Create credit note

X

Delete a credit note

X

Download e-invoice for credit note

X

Import credit note

X

List credit notes

X

Record refund for a credit note

X

Refund a credit note

X

Remove tax withheld refunds from a credit note

X

Resend failed e-invoice in credit notes

X

Retrieve a credit note

X

Retrieve credit note as PDF

X

Send an e-invoice for credit notes

X

Void a credit note

X

CSV tax rules

Taxes CSV import

X

Currencies

Add a new currency

X

Add schedule

X

List currencies

X

Remove schedule

X

Retrieve a currency

X

Update a currency

X

Custom field configs

List custom field configs

X

Retrieve the metadata

X

Customers

Add contacts to a customer

X

Assign payment role

X

Change billing date

X

Clear personal data of a customer

X

Collect payment for customer

X

Copy card

X

Create a customer

X

Create a quote for subscription creation

X

Create subscription for items

X

Delete a customer

X

Delete card for a customer

X

Delete contacts for a customer

X

Estimate for creating a subscription

X

Get account hierarchy for a customer

X

Get paginated account hierarchy for a customer

X

Import subscription for items

X

Link a customer to an account hierarchy

X

List customer entitlements

X

List customers

X

List of contacts for a customer

X

List vouchers for a customer

X

Merge customers

X

Move a customer

X

Record an excess payment for a customer

X

Retrieve a customer

X

Switch gateway

X

Unlink a customer from its parent account

X

Upcoming invoices estimate

X

Update a customer

X

Update account hierarchy access settings for a customer

X

Update billing info for a customer

X

Update card for a customer

X

Update contacts for a customer

X

Update payment method for a customer

X

Differential prices

Delete a differential price

X

List differential prices

X

Retrieve a differential price

X

Update a differential price

X

Entitlements

List entitlements

X

Manage entitlements for a feature

X

Estimates

Create a payment schedule estimate

X

Create invoice for items estimate

X

Estimate for creating a customer and subscription

X

Estimate for updating a subscription

X

Gift subscription estimate for items

X

Events

List events

X

Retrieve an event

X

Exports

Export attached items

X

Export coupons

X

Export credit notes

X

Export customers

X

Export deferred revenue reports

X

Export differential price

X

Export invoices

X

Export item families

X

Export item prices

X

Export items

X

Export orders

X

Export price variants

X

Export revenue recognition reports

X

Export subscriptions

X

Export transactions

X

Retrieve an export

X

Features

Activate a feature

X

Archive a feature

X

Create a feature

X

Delete a feature

X

List features

X

List item entitlements for a feature

X

Reactivate a feature

X

Retrieve a feature

X

Update a feature

X

§brand0§ert or remove item entitlements for a feature

X

Full exports

Retrieve full export status

X

Gifts

Cancel a gift

X

Claim a gift

X

Create a gift subscription for items

X

List gifts

X

Retrieve a gift

X

Update a gift

X

Hosted pages

Accept a quote

X

Acknowledge a hosted page

X

Checkout charge items and one time charges

X

Checkout gift subscription for items

X

Claim a gift subscription

X

Collect now

X

Create a hosted page to view boleto vouchers

X

Create a pre cancel hosted page

X

Create checkout for a new subscription

X

Create checkout to update a subscription

X

Extend subscription

X

List hosted pages

X

Manage payment sources

X

Notify an event

X

Retrieve a hosted page

X

Retrieve direct debit agreement PDF

X

Update payment method

X

In app subscriptions

Import receipt

X

Import subscription without receipt

X

Process purchase command

X

Retrieve store subscription

X

Invoices

Add a charge item to a pending invoice

X

Add one time charge to a pending invoice

X

Apply credits for an invoice

X

Apply payment schedule scheme to an invoice

X

Apply payments for an invoice

X

Close a pending invoice

X

Collect payment for an invoice

X

Create invoice for items and one time charges

X

Delete an invoice

X

Delete line items

X

Download e-invoice

X

Import invoice

X

List invoices

X

List payment reference numbers

X

List payments for an invoice

X

List vouchers for an invoice

X

Pause dunning for invoice

X

Record an invoice payment

X

Record refund for an invoice

X

Record tax withheld for an invoice

X

Refund an invoice

X

Remove credit note from an invoice

X

Remove payment from an invoice

X

Remove tax withheld for an invoice

X

Resend failed e-invoice in invoices

X

Resume dunning for invoice

X

Retrieve an invoice

X

Retrieve invoice as PDF

X

Retrieve payment schedules for an invoice

X

Send an e-invoice for invoices

X

Stop dunning for invoice

X

Sync usages

X

Update invoice details

X

Void an invoice

X

Write off an invoice

X

Item families

Create an item family

X

Delete an item family

X

List item families

X

Retrieve an item family

X

Update an item family

X

Item prices

Create a differential price

X

Create an item price

X

Delete an item price

X

List applicable item prices for a plan item price

X

List applicable items for a plan item price

X

List item prices

X

Retrieve an item price

X

Update an item price

X

Items

Create an attached item

X

Create an item

X

Delete an item

X

List attached items

X

List item entitlements for an item

X

List items

X

Retrieve an item

X

Update an item

X

§brand0§ert or remove item entitlements for an item

X

Non subscriptions

One time purchase

X

Offer events

Create an offer event

X

Offer fulfillments

Create an offer fulfillment

X

Retrieve an offer fulfillment

X

Update an offer fulfillment

X

Omnichannel one time orders

List omnichannel one time orders

X

Retrieve an one time order one time order

X

Omnichannel subscription items

List scheduled changes for omnichannel subscription item

X

Omnichannel subscriptions

List omnichannel subscriptions

X

List omnichannel transactions of an omnichannel subscription

X

Move an omnichannel subscription

X

Retrieve an omnichannel subscription

X

Orders

Assign order number

X

Cancel an order

X

Create a refundable credit note

X

Create an order

X

Delete an imported order

X

Import an order

X

List orders

X

Reopen a cancelled order

X

Resend an order

X

Retrieve an order

X

Update an order

X

Payment intents

Create a payment intent

X

Retrieve a payment intent

X

Update a payment intent

X

Payment schedule schemes

Create a payment schedule scheme

X

Delete a payment schedule scheme

X

Retrieve a payment schedule scheme

X

Payment sources

Create a bank account payment source

X

Create a card payment source

X

Create a voucher payment method

X

Create using Chargebee token

X

Create using gateway temporary token

X

Create using payment intent

X

Create using permanent token

X

Delete a payment source

X

Export payment source

X

List payment sources

X

Local delete a payment source

X

Retrieve a payment source

X

Switch gateway account

X

Update a bank account payment source

X

Update a card payment source

X

Verify bank account payment source

X

Payment vouchers

Create a voucher for the customer to initiate payment

X

Retrieve voucher data

X

PC2 migration item families

Create a PC2 migration item family

X

Delete draft family

X

List PC2 migration item families

X

Retrieve a PC2 migration item family

X

Update a PC2 migration item family

X

PC2 migration item prices

Delete draft item price

X

List PC2 migration item prices

X

Retrieve a PC2 migration item price

X

Update a PC2 migration item price

X

PC2 migration items

Applicable items a PC2 migration item

X

Create a PC2 migration item

X

Delete draft item

X

List PC2 migration items

X

Retrieve a PC2 migration item

X

Update a PC2 migration item

X

PC2 migrations

Contact support a PC2 migration

X

Create a PC2 migration

X

Initiate a PC2 migration

X

Retrieve a PC2 migration

X

Personalized offers

List personalized offers

X

Portal sessions

Activate a portal session

X

Create a portal session

X

Logout a portal session

X

Retrieve a portal session

X

Price variants

Create a price variant

X

Delete a price variant

X

List price variants

X

Retrieve a price variant

X

Update a price variant

X

Pricing page sessions

Create pricing page for existing subscription

X

Create pricing page for new subscription

X

Products

Add remove or update options for the product

X

Create a product

X

Create a product variant

X

Delete a product

X

List product variants

X

List products

X

Retrieve a product

X

Update a product

X

Promotional credits

Add promotional credits

X

Deduct promotional credits

X

List promotional credits

X

Retrieve a promotional credit

X

Set promotional credits

X

Purchases

Create a purchase

X

Estimates for purchase

X

Quotes

Convert a quote

X

Create a quote for charges and charge items

X

Create a quote for subscription update

X

Delete a quote

X

Edit a quote for charges and charge items

X

Edit a quote for subscription creation

X

Edit a quote for subscription update

X

Extend expiry date

X

List quote line groups

X

List quotes

X

Retrieve a quote as PDF

X

Retrieve a quote

X

Update quote status

X

Ramps

Delete a subscription ramp

X

List subscription ramps

X

Retrieve a subscription ramp

X

Update a subscription ramp

X

Recorded purchases

Record a purchase

X

Retrieve a recorded purchase

X

Resource migrations

Retrieve latest migration details

X

Rules

Retrieve rule data

X

Site migration details

List site migration details

X

Site pc meta records

List site pc meta records

X

Subscriptions

Add charge at term end

X

Advance invoice estimate

X

Cancel subscription for items estimate

X

Cancel subscription for items

X

Change term end

X

Charge future renewals

X

Create a subscription ramp

X

Create a usage

X

Delete a subscription

X

Delete a usage

X

Edit advance invoice schedule

X

Enable or disable subscription entitlements

X

Import contract term

X

Import unbilled charges

X

List contract terms for a subscription

X

List discounts for a subscription

X

List entitlement overrides for a subscription

X

List subscription entitlements

X

List subscriptions

X

Move a subscription

X

Override billing profile

X

Pause a subscription

X

Pause subscription estimate

X

Reactivate a subscription

X

Regenerate an invoice

X

Regenerate invoice estimate

X

Remove an advance invoice schedules

X

Remove coupons

X

Remove scheduled cancellation

X

Remove scheduled changes

X

Remove scheduled pause

X

Remove scheduled resumption

X

Resume a subscription

X

Resume subscription estimate

X

Retrieve a subscription

X

Retrieve a usage

X

Retrieve advance invoice

X

Retrieve with scheduled changes

X

Scheduled changes a subscription scheduled change

X

Subscription change term end estimate

X

Subscription renewal estimate

X

Update scheduled changes a subscription scheduled change

X

Update subscription for items

X

Remove entitlement overrides for a subscription

X

Time machines

Retrieve a time machine

X

Start afresh

X

Travel forward

X

Tokens

Create a card payment method token

X

Create using vault temp token

X

Retrieve a token

X

Transactions

Create an authorization payment

X

Delete an offline transaction

X

List transactions

X

Reconcile transaction

X

Record an offline refund

X

Refund a payment

X

Retrieve a transaction

X

Void an authorization transaction

X

Unbilled charges

Create an estimate for unbilled charges

X

Create an invoice for unbilled charges

X

Create unbilled charges for item subscription

X

Delete an unbilled charge

X

List unbilled charges

X

Usage events

Ingest a usage event

X

Usage files

Retrieve file processing status

X

Retrieve usage file upload URL

X

Usages

List usages

X

Retrieve usages for an invoice as PDF

X

Variants

Delete a product variant

X

Retrieve a product variant

X

Update a product variant

X

Virtual bank accounts

Create a virtual bank account

X

Create a virtual bank account using permanent token

X

Delete a virtual bank account

X

List virtual bank accounts

X

Local delete a virtual bank account

X

Retrieve a virtual bank account

X

Webhook endpoints

Create a webhook endpoint

X

Delete a webhook endpoint

X

List webhook endpoints

X

Retrieve a webhook endpoint

X

Update webhook endpoint

X