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

Addons

List addons

X

Retrieve an addon

X

Create an addon

X

Update an addon

X

Delete an addon

X

Addresses

Retrieve an address

X

Update an address

X

Update an address

X

Cards

Retrieve card for a customer

X

Update card for a customer

X

Delete card for a customer

X

Comments

List comments

X

Retrieve a comment

X

Create a comment

X

Delete a comment

X

Create a comment

X

Delete a comment

X

Coupon codes

List coupon codes

X

Retrieve a coupon code

X

Archive a coupon code

X

Archive a coupon code

X

Coupon sets

List coupon sets

X

Retrieve a coupon set

X

Create a coupon set

X

Update a coupon set

X

Delete a coupon set

X

Add coupon codes to coupon set

X

Delete unused coupon codes

X

Create a coupon set

X

Update a coupon set

X

Create or Update a Coupon set

X

Delete a coupon set

X

Add coupon codes to coupon set

X

Delete unused coupon codes

X

Coupons

List coupons

X

Retrieve a coupon

X

Create a coupon

X

Update a coupon

X

Delete a coupon

X

Credit notes

List credit notes

X

Retrieve a credit note

X

Create a credit note

X

Void a credit notes

X

Delete a credit note

X

Customers

List customers

X

Retrieve a customer

X

List of contacts for a customer

X

Create a customer

X

Update a customer

X

Delete a customer

X

Update payment method for a customer

X

Update billing info for a customer

X

Assign payment role

X

Add contacts to a customer

X

Update contacts for a customer

X

Delete contacts for a customer

X

Add promotional credits to a customer

X

Deduct promotional credits to a customer

X

Set promotional credits for a customer

X

Record an excess payment for a customer

X

Move a customer

X

Change billing date

X

Merge customers

X

Clear personal data of a customer

X

Estimates

Upcoming invoices estimate

X

Create subscription estimate

X

Update subscription estimate

X

Subscription change term end estimate

X

Cancel subscription estimate

X

Pause subscription estimate

X

Resume subscription estimate

X

Events

List events

X

Retrieve an event

X

Gifts

List gifts

X

Retrieve a gift

X

Create a gift

X

Claim a gift

X

Cancel a gift

X

Hosted pages

List hosted pages

X

Retrieve a hosted page

X

Checkout new subscription

X

Checkout existing subscription

X

Update payment method

X

Manage payment sources

X

Collect now

X

Accept a quote

X

Extend subscription

X

Checkout gift subscription

X

Claim a gift subscription

X

Invoices

List invoices

X

Retrieve an invoice

X

Create an invoice

X

Create invoice for charge

X

Create invoice for addon

X

Stop dunning for invoice

X

Import an invoice

X

Apply payments for an invoice

X

Apply credits for an invoice

X

Add charge item to pending invoice

X

Add addon item to pending invoice

X

Close a pending invoice

X

Collect payment for an invoice

X

Record an invoice payment

X

Refund an invoice

X

Record refund for an invoice

X

Remove payment from an invoice

X

Remove credit note from an invoice

X

Void an invoice

X

Write off an invoice

X

Delete an invoice

X

Update invoice details

X

Orders

List orders

X

Retrieve an order

X

Create an order

X

Update an order

X

Create a refundable credit note

X

Assign order number

X

Cancel an order

X

Reopen an order

X

Payment sources

List payment sources

X

Retrieve a payment source

X

Create using gateway temporary token

X

Create using permanent token

X

Create a card payment source

X

Update a card payment source

X

Delete a payment source

X

Plans

List plans

X

Retrieve a plan

X

Create a plan

X

Update a plan

X

Delete a plan

X

Copy a plan

X

Unarchive a plan

X

Promotional credits

List promotional credits

X

Retrieve a promotional credit

X

Add promotional credits

X

Deduct promotional credits

X

Set promotional credits

X

Quotes

List quotes

X

Retrieve a quote

X

Create a quote for a new subscription

X

Create a quote for update subscription

X

Create a quote for one-time charges

X

Convert a quote

X

Update quote status

X

Delete a quote

X

Site migration details

List site migration details

X

Subscriptions

List subscriptions

X

Retrieve a subscription

X

Retrieve with scheduled changes

X

Create a subscription

X

Update a subscription

X

Delete a subscription

X

Create subscription for customer

X

Remove scheduled changes

X

Remove scheduled cancellation

X

Remove coupons

X

Change term end

X

Cancel a subscription

X

Reactivate a subscription

X

Add charge at term end

X

Charge addon at term end

X

Charge future renewals

X

Import a subscription

X

Import subscription for customer

X

Override billing profile

X

Pause a subscription

X

Resume a subscription

X

Remove scheduled pause

X

Remove scheduled resumption

X

Transactions

List transactions

X

Retrieve a transaction

X

List payments for an invoice

X

Create an authorization payment

X

Void an authorization transaction

X

Delete an offline transaction

X

Unbilled charges

List unbilled charges

X

Create an invoice for unbilled charges

X

Create an estimate for unbilled charges

X

Delete an unbilled charge

X

Virtual bank accounts

List virtual bank accounts

X

Create a virtual bank account using permanent token

X

Create a virtual bank account

X

Local delete a virtual bank account

X

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.