Available Chargebee APIs

Naga Sri Hari Gonaboyina

Updated October 05, 2026 11:58

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
Addresses	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
Business entities	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
Custom field configs	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
Entitlements	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
Events	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
Omnichannel one time orders	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
Payment vouchers	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
Pricing page sessions	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
Purchases	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
Recorded purchases	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
Usage files	Retrieve usage file upload URL		X
Usages	List usages	X
Usages	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

Available DI objects

The following objects are available when using Chargebee as a source in Celigo Data Integration (DI).

Primary key: Every Chargebee DI object is returned wrapped in a named resource object, and the primary key is that wrapper's id — for example customer.id, subscription.id, invoice.id, coupon.id, item.id, and so on across all resources. The nested string id is the consistent key for every object.

Note

Chargebee generally does not remove records silently. Many resources expose status transitions or a deleted flag (for example, subscriptions move to cancelled, resources can be marked deleted) rather than being physically removed, and deletions are additionally surfaced through the Events API (the List events object) as *_deleted event types. Records that are hard-deleted otherwise stop appearing in list results rather than being returned with a deleted marker.

Object	API endpoint	Available extract modes	Delta field
Business entities	List business entity transfers	Full, Incremental	`created_at[after]`
Comments	List comments	Full, Incremental	`created_at[after]`
Coupon codes	List coupon codes	Full	—
Coupon sets	List coupon sets	Full	—
Coupons	List coupons	Full, Incremental	`updated_at[after]`
Credit notes	List credit notes	Full, Incremental	`updated_at[after]`
Customers	List customers	Full, Incremental	`updated_at[after]`
Differential prices	List differential prices	Full	—
Entitlements	List entitlements	Full	—
Events	List events	Full	—
Features	List features	Full	—
Gifts	List gifts	Full	—
Invoices	List invoices	Full, Incremental	`updated_at[after]`
Item families	List item families	Full, Incremental	`updated_at[after]`
Item prices	List item prices	Full, Incremental	`updated_at[after]`
Items	List items	Full, Incremental	`updated_at[after]`
Omnichannel one time orders	List omnichannel one time orders	Full	—
Omnichannel subscriptions	List omnichannel subscriptions	Full	—
Orders	List orders	Full, Incremental	`updated_at[after]`
Payment sources	List payment sources	Full, Incremental	`updated_at[after]`
Price variants	List price variants	Full, Incremental	`updated_at[after]`
Products	List products	Full, Incremental	`updated_at[after]`
Promotional credits	List promotional credits	Full, Incremental	`created_at[after]`
Quotes	List quotes	Full, Incremental	`updated_at[after]`
Ramps	List subscription ramps	Full, Incremental	`updated_at[after]`
Subscriptions	List subscriptions	Full, Incremental	`updated_at[after]`
Transactions	List transactions	Full, Incremental	`updated_at[after]`
Unbilled charges	List unbilled charges	Full	—
Usages	List usages	Full, Incremental	`updated_at[after]`
Virtual bank accounts	List virtual bank accountss	Full, Incremental	`updated_at[after]`

Response schemas

Click an object below to view its response fields and delta configuration.

Business entities — List business entity transfers

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`created_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`business_entity_transfer`	object
`business_entity_transfer.id`	string (Primary key)
`business_entity_transfer.active_resource_id`	string
`business_entity_transfer.resource_id`	string
`business_entity_transfer.resource_type`	string
`business_entity_transfer.destination_business_entity_id`	string
`business_entity_transfer.source_business_entity_id`	string
`business_entity_transfer.status`	string
`business_entity_transfer.created_at`	number
`business_entity_transfer.initiated_by`	string
`business_entity_transfer.object`	string
`business_entity_transfer.transfer_details`	objectarray
`business_entity_transfer.transfer_details.resource_type`	string
`business_entity_transfer.transfer_details.resource_id`	string
`business_entity_transfer.transfer_details.active_resource_id`	string
`business_entity_transfer.transfer_details.object`	string

Comments — List comments

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`created_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`comment`	object
`comment.id`	string (Primary key)
`comment.entity_type`	string
`comment.added_by`	string
`comment.notes`	string
`comment.entity_id`	string
`comment.type`	string
`comment.created_at`	number
`comment.object`	string

Coupon codes — List coupon codes

Response schema:

Field	Type
`coupon_code`	object
`coupon_code.id`	string (Primary key)
`coupon_code.code`	string
`coupon_code.coupon_id`	string
`coupon_code.coupon_set_id`	string
`coupon_code.coupon_set_name`	string
`coupon_code.status`	string
`coupon_code.object`	string

Coupon sets — List coupon sets

Response schema:

Field	Type
`coupon_set`	object
`coupon_set.id`	string (Primary key)
`coupon_set.name`	string
`coupon_set.coupon_id`	string
`coupon_set.total_count`	number
`coupon_set.redeemed_count`	number
`coupon_set.archived_count`	number
`coupon_set.object`	string
`coupon_set.meta_data`	object

Coupons — List coupons

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`coupon`	object
`coupon.id`	string (Primary key)
`coupon.name`	string
`coupon.invoice_name`	string
`coupon.discount_type`	string
`coupon.discount_percentage`	number
`coupon.discount_amount`	number
`coupon.currency_code`	string
`coupon.duration_type`	string
`coupon.duration_month`	number
`coupon.valid_till`	number
`coupon.max_redemptions`	number
`coupon.status`	string
`coupon.apply_discount_on`	string
`coupon.apply_on`	string
`coupon.created_at`	number
`coupon.archived_at`	number
`coupon.resource_version`	string
`coupon.updated_at`	number
`coupon.period`	number
`coupon.period_unit`	string
`coupon.redemptions`	boolean
`coupon.invoice_notes`	string
`coupon.coupon_type`	string
`coupon.deleted`	boolean
`coupon.object`	string
`coupon.business_entity_id`	string
`coupon.plan_constraint`	string
`coupon.addon_constraint`	string
`coupon.plan_ids`	stringarray
`coupon.addon_ids`	stringarray
`coupon.item_constraints`	objectarray
`coupon.item_constraints.item_type`	string
`coupon.item_constraints.constraint`	string
`coupon.item_constraints.item_price_ids`	stringarray
`coupon.item_constraint_criteria`	objectarray
`coupon.item_constraint_criteria.item_type`	string
`coupon.item_constraint_criteria.currencies`	string
`coupon.item_constraint_criteria.item_family_ids`	string
`coupon.item_constraint_criteria.item_price_periods`	string
`coupon.coupon_constraints`	objectarray
`coupon.coupon_constraints.entity_type`	string
`coupon.coupon_constraints.type`	string
`coupon.coupon_constraints.value`	string
`coupon.meta_data`	object

Credit notes — List credit notes

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`credit_note`	object
`credit_note.id`	string (Primary key)
`credit_note.customer_id`	string
`credit_note.subscription_id`	string
`credit_note.reference_invoice_id`	string
`credit_note.type`	string
`credit_note.reason_code`	string
`credit_note.create_reason_code`	number
`credit_note.status`	string
`credit_note.vat_number`	string
`credit_note.date`	number
`credit_note.price_type`	string
`credit_note.currency_code`	string
`credit_note.total`	number
`credit_note.amount_allocated`	number
`credit_note.amount_refunded`	number
`credit_note.amount_available`	number
`credit_note.refunded_at`	number
`credit_note.voided_at`	number
`credit_note.generated_at`	number
`credit_note.updated_at`	number
`credit_note.resource_version`	number
`credit_note.sub_total`	number
`credit_note.sub_total_in_local_currency`	number
`credit_note.total_in_local_currency`	number
`credit_note.local_currency_code`	string
`credit_note.round_off_amount`	number
`credit_note.fractional_correction`	number
`credit_note.deleted`	boolean
`credit_note.object`	string
`credit_note.channel`	string
`credit_note.business_entity_id`	string
`credit_note.base_currency_code`	string
`credit_note.vat_number_prefix`	string
`credit_note.create_reason_code_v2`	string
`credit_note.line_items`	objectarray
`credit_note.line_items.id`	string
`credit_note.line_items.date_from`	number
`credit_note.line_items.date_to`	number
`credit_note.line_items.unit_amount`	number
`credit_note.line_items.quantity`	number
`credit_note.line_items.amount`	number
`credit_note.line_items.pricing_model`	number
`credit_note.line_items.is_taxed`	boolean
`credit_note.line_items.tax_amount`	number
`credit_note.line_items.tax_rate`	number
`credit_note.line_items.unit_amount_in_decimal`	number
`credit_note.line_items.quantity_in_decimal`	string
`credit_note.line_items.amount_in_decimal`	string
`credit_note.line_items.discount_amount`	number
`credit_note.line_items.item_level_discount_amount`	number
`credit_note.line_items.description`	string
`credit_note.line_items.entity_type`	string
`credit_note.line_items.entity_id`	string
`credit_note.line_items.subscription_id`	string
`credit_note.line_items.customer_id`	string
`credit_note.line_items.reference_line_item_id`	string
`credit_note.line_items.tax_exempt_reason`	string
`credit_note.line_items.discount_type`	number
`credit_note.line_items.object`	string
`credit_note.discounts`	objectarray
`credit_note.discounts.id`	string
`credit_note.discounts.invoice_name`	string
`credit_note.discounts.type`	string
`credit_note.discounts.percentage`	number
`credit_note.discounts.amount`	number
`credit_note.discounts.currency_code`	string
`credit_note.discounts.duration_type`	string
`credit_note.discounts.period`	number
`credit_note.discounts.period_unit`	string
`credit_note.discounts.included_in_mrr`	boolean
`credit_note.discounts.apply_on`	string
`credit_note.discounts.item_price_id`	string
`credit_note.discounts.created_at`	number
`credit_note.discounts.apply_till`	number
`credit_note.discounts.object`	string
`credit_note.line_item_discounts`	objectarray
`credit_note.line_item_discounts.line_item_id`	string
`credit_note.line_item_discounts.discount_type`	string
`credit_note.line_item_discounts.coupon_id`	string
`credit_note.line_item_discounts.entity_id`	string
`credit_note.line_item_discounts.discount_amount`	number
`credit_note.line_item_discounts.object`	string
`credit_note.line_item_tiers`	objectarray
`credit_note.line_item_tiers.line_item_id`	string
`credit_note.line_item_tiers.starting_unit`	number
`credit_note.line_item_tiers.ending_unit`	number
`credit_note.line_item_tiers.quantity_used`	number
`credit_note.line_item_tiers.unit_amount`	number
`credit_note.line_item_tiers.starting_unit_in_decimal`	string
`credit_note.line_item_tiers.ending_unit_in_decimal`	string
`credit_note.line_item_tiers.quantity_used_in_decimal`	string
`credit_note.line_item_tiers.unit_amount_in_decimal`	string
`credit_note.line_item_tiers.pricing_type`	string
`credit_note.line_item_tiers.package_size`	number
`credit_note.line_item_tiers.object`	string
`credit_note.taxes`	objectarray
`credit_note.taxes.name`	string
`credit_note.taxes.amount`	number
`credit_note.taxes.description`	string
`credit_note.line_item_taxes`	objectarray
`credit_note.line_item_taxes.line_item_id`	string
`credit_note.line_item_taxes.tax_name`	string
`credit_note.line_item_taxes.tax_rate`	number
`credit_note.line_item_taxes.tax_amount`	number
`credit_note.line_item_taxes.tax_juris_type`	string
`credit_note.line_item_taxes.tax_juris_name`	string
`credit_note.line_item_taxes.tax_juris_code`	string
`credit_note.line_item_taxes.tax_amount_in_local_currency`	number
`credit_note.line_item_taxes.local_currency_code`	string
`credit_note.line_item_taxes.object`	string
`credit_note.linked_refunds`	objectarray
`credit_note.linked_refunds.txn_id`	string
`credit_note.linked_refunds.applied_amount`	string
`credit_note.linked_refunds.applied_at`	number
`credit_note.linked_refunds.txn_status`	string
`credit_note.linked_refunds.txn_date`	string
`credit_note.linked_refunds.txn_amount`	number
`credit_note.linked_refunds.object`	string
`credit_note.allocations`	objectarray
`credit_note.allocations.invoice_id`	string
`credit_note.allocations.allocated_amount`	string
`credit_note.allocations.allocated_at`	number
`credit_note.allocations.invoice_date`	number
`credit_note.allocations.invoice_status`	string
`credit_note.allocations.object`	string
`credit_note.shipping_address`	object
`credit_note.shipping_address.first_name`	string
`credit_note.shipping_address.last_name`	string
`credit_note.shipping_address.email`	string
`credit_note.shipping_address.company`	string
`credit_note.shipping_address.phone`	string
`credit_note.shipping_address.line1`	string
`credit_note.shipping_address.line2`	string
`credit_note.shipping_address.line3`	string
`credit_note.shipping_address.city`	string
`credit_note.shipping_address.state_code`	string
`credit_note.shipping_address.state`	string
`credit_note.shipping_address.country`	string
`credit_note.shipping_address.zip`	string
`credit_note.shipping_address.validation_status`	string
`credit_note.shipping_address.object`	string
`credit_note.billing_address`	object
`credit_note.billing_address.first_name`	string
`credit_note.billing_address.last_name`	string
`credit_note.billing_address.email`	string
`credit_note.billing_address.company`	string
`credit_note.billing_address.phone`	string
`credit_note.billing_address.line1`	string
`credit_note.billing_address.line2`	string
`credit_note.billing_address.line3`	string
`credit_note.billing_address.city`	string
`credit_note.billing_address.state_code`	string
`credit_note.billing_address.state`	string
`credit_note.billing_address.country`	string
`credit_note.billing_address.zip`	string
`credit_note.billing_address.validation_status`	string
`credit_note.billing_address.object`	string

Customers — List customers

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`customer`	object
`customer.id`	string (Primary key)
`customer.first_name`	string
`customer.last_name`	string
`customer.email`	string
`customer.phone`	string
`customer.company`	string
`customer.vat_number`	string
`customer.auto_collection`	string
`customer.net_term_days`	number
`customer.allow_direct_debit`	boolean
`customer.is_location_valid`	boolean
`customer.created_at`	number
`customer.created_from_ip`	number
`customer.taxability`	string
`customer.entity_code`	string
`customer.exempt_number`	string
`customer.resource_version`	number
`customer.updated_at`	number
`customer.locale`	string
`customer.billing_date`	number
`customer.billing_date_mode`	string
`customer.billing_day_of_week`	string
`customer.billing_day_of_week_mode`	string
`customer.pii_cleared`	string
`customer.card_status`	string
`customer.fraud_flag`	string
`customer.primary_payment_source_id`	string
`customer.backup_payment_source_id`	string
`customer.promotional_credits`	number
`customer.refundable_credits`	number
`customer.excess_payments`	number
`customer.unbilled_charges`	number
`customer.preferred_currency_code`	string
`customer.mrr`	string
`customer.customer_type`	string
`customer.deleted`	boolean
`customer.object`	string
`customer.consolidated_invoicing`	boolean
`customer.auto_close_invoices`	number
`customer.channel`	string
`customer.business_entity_id`	string
`customer.vat_number_validated_time`	string
`customer.vat_number_status`	string
`customer.client_profile_id`	string
`customer.billing_address`	object
`customer.billing_address.first_name`	string
`customer.billing_address.last_name`	string
`customer.billing_address.email`	string
`customer.billing_address.company`	string
`customer.billing_address.phone`	string
`customer.billing_address.line1`	string
`customer.billing_address.line2`	string
`customer.billing_address.line3`	string
`customer.billing_address.city`	string
`customer.billing_address.state_code`	string
`customer.billing_address.state`	string
`customer.billing_address.country`	string
`customer.billing_address.zip`	string
`customer.billing_address.validation_status`	string
`customer.billing_address.object`	string
`customer.referral_urls`	objectarray
`customer.referral_urls.external_customer_id`	string
`customer.referral_urls.referral_sharing_url`	string
`customer.referral_urls.created_at`	string
`customer.referral_urls.updated_at`	number
`customer.referral_urls.referral_campaign_id`	string
`customer.referral_urls.referral_account_id`	string
`customer.referral_urls.referral_external_campaign_id`	string
`customer.referral_urls.referral_system`	string
`customer.referral_urls.object`	string
`customer.contacts`	objectarray
`customer.contacts.id`	string
`customer.contacts.first_name`	string
`customer.contacts.last_name`	string
`customer.contacts.email`	string
`customer.contacts.phone`	string
`customer.contacts.label`	string
`customer.contacts.enabled`	boolean
`customer.contacts.send_account_email`	boolean
`customer.contacts.send_billing_email`	boolean
`customer.contacts.object`	string
`customer.payment_method`	object
`customer.payment_method.object`	string
`customer.payment_method.type`	string
`customer.payment_method.gateway`	string
`customer.payment_method.gateway_account_id`	string
`customer.payment_method.status`	string
`customer.payment_method.reference_id`	string
`customer.balances`	objectarray
`customer.balances.promotional_credits`	number
`customer.balances.excess_payments`	number
`customer.balances.refundable_credits`	number
`customer.balances.unbilled_charges`	number
`customer.balances.currency_code`	string
`customer.balances.balance_currency_code`	string
`customer.balances.object`	string
`customer.entity_identifiers`	objectarray
`customer.entity_identifiers.id`	string
`customer.entity_identifiers.scheme`	string
`customer.entity_identifiers.value`	string
`customer.entity_identifiers.type`	string
`customer.entity_identifiers.standard`	string
`customer.entity_identifiers.object`	string
`customer.relationship`	object
`customer.relationship.parent_id`	string
`customer.relationship.payment_owner_id`	string
`customer.relationship.invoice_owner_id`	string
`customer.meta_data`	object

Differential prices — List differential prices

Response schema:

Field	Type
`differential_price`	object
`differential_price.id`	string (Primary key)
`differential_price.item_price_id`	string
`differential_price.parent_item_id`	string
`differential_price.price`	number
`differential_price.price_in_decimal`	string
`differential_price.status`	string
`differential_price.resource_version`	number
`differential_price.updated_at`	number
`differential_price.created_at`	number
`differential_price.object`	string
`differential_price.tiers`	objectarray
`differential_price.tiers.starting_unit`	number
`differential_price.tiers.ending_unit`	number
`differential_price.tiers.price`	number
`differential_price.tiers.starting_unit_in_decimal`	string
`differential_price.tiers.ending_unit_in_decimal`	string
`differential_price.tiers.price_in_decimal`	string
`differential_price.tiers.pricing_type`	string
`differential_price.tiers.package_size`	number
`differential_price.parent_periods`	objectarray
`differential_price.parent_periods.period_unit`	string
`differential_price.parent_periods.period`	numberarray

Entitlements — List entitlements

Response schema:

Field	Type
`entitlement`	object
`entitlement.id`	string (Primary key)
`entitlement.entity_id`	string
`entitlement.entity_type`	string
`entitlement.feature_id`	string
`entitlement.feature_name`	string
`entitlement.feature_unit`	string
`entitlement.value`	string
`entitlement.name`	string
`entitlement.created_at`	number
`entitlement.updated_at`	number
`entitlement.resource_version`	number
`entitlement.object`	string

Events — List events

Response schema:

Field	Type
`event`	object
`event.id`	string (Primary key)
`event.occurred_at`	number
`event.source`	string
`event.user`	string
`event.webhook_status`	number
`event.webhook_failure_reason`	string
`event.event_type`	string
`event.api_version`	string
`event.webhooks`	objectarray
`event.webhooks.id`	string
`event.webhooks.webhook_status`	string
`event.webhooks.object`	string
`event.object`	string
`event.content`	object

Features — List features

Response schema:

Field	Type
`feature`	object
`feature.id`	string (Primary key)
`feature.name`	string
`feature.description`	string
`feature.status`	string
`feature.type`	string
`feature.unit`	string
`feature.created_at`	number
`feature.updated_at`	number
`feature.resource_version`	number
`feature.object`	string
`feature.levels`	objectarray
`feature.levels.id`	string
`feature.levels.name`	string
`feature.levels.value`	string
`feature.levels.level`	number
`feature.levels.is_unlimited`	boolean
`feature.levels.object`	string

Gifts — List gifts

Response schema:

Field	Type
`gift`	object
`gift.id`	string (Primary key)
`gift.status`	string
`gift.scheduled_at`	number
`gift.auto_claim`	number
`gift.no_expiry`	boolean
`gift.claim_expiry_date`	number
`gift.subscription_id`	string
`gift.invoice_id`	string
`gift.resource_version`	number
`gift.updated_at`	number
`gift.object`	string
`gift.gift_receiver`	object
`gift.gift_receiver.customer_id`	string
`gift.gift_receiver.subscription_id`	string
`gift.gift_receiver.first_name`	string
`gift.gift_receiver.last_name`	string
`gift.gift_receiver.email`	string
`gift.gifter`	object
`gift.gifter.customer_id`	string
`gift.gifter.invoice_id`	string
`gift.gifter.signature`	string
`gift.gifter.note`	string
`gift.gifter.payment_src_id`	string
`gift.gift_timelines`	objectarray
`gift.gift_timelines.status`	string
`gift.gift_timelines.occurred_at`	number

Invoices — List invoices

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`invoice`	object
`invoice.id`	string (Primary key)
`invoice.po_number`	string
`invoice.customer_id`	string
`invoice.subscription_id`	string
`invoice.recurring`	boolean
`invoice.status`	string
`invoice.vat_number`	string
`invoice.price_type`	string
`invoice.date`	number
`invoice.due_date`	number
`invoice.net_term_days`	string
`invoice.exchange_rate`	string
`invoice.currency_code`	string
`invoice.total`	number
`invoice.amount_paid`	number
`invoice.amount_adjusted`	number
`invoice.write_off_amount`	number
`invoice.credits_applied`	number
`invoice.amount_due`	number
`invoice.paid_at`	number
`invoice.updated_at`	number
`invoice.resource_version`	number
`invoice.dunning_status`	string
`invoice.next_retry_at`	number
`invoice.sub_total`	number
`invoice.sub_total_in_local_currency`	number
`invoice.total_in_local_currency`	number
`invoice.local_currency_code`	string
`invoice.tax`	number
`invoice.first_invoice`	boolean
`invoice.has_advance_charges`	boolean
`invoice.is_gifted`	boolean
`invoice.term_finalized`	string
`invoice.is_digital`	boolean
`invoice.generated_at`	number
`invoice.deleted`	boolean
`invoice.object`	string
`invoice.vat_number_prefix`	string
`invoice.channel`	string
`invoice.business_entity_id`	string
`invoice.amount_to_collect`	number
`invoice.round_off_amount`	number
`invoice.base_currency_code`	string
`invoice.new_sales_amount`	number
`invoice.line_items`	objectarray
`invoice.line_items.id`	string
`invoice.line_items.date_from`	number
`invoice.line_items.date_to`	number
`invoice.line_items.unit_amount`	number
`invoice.line_items.quantity`	number
`invoice.line_items.amount`	number
`invoice.line_items.pricing_model`	number
`invoice.line_items.is_taxed`	boolean
`invoice.line_items.tax_amount`	number
`invoice.line_items.tax_rate`	number
`invoice.line_items.unit_amount_in_decimal`	number
`invoice.line_items.quantity_in_decimal`	string
`invoice.line_items.amount_in_decimal`	string
`invoice.line_items.discount_amount`	number
`invoice.line_items.item_level_discount_amount`	number
`invoice.line_items.description`	string
`invoice.line_items.entity_type`	string
`invoice.line_items.entity_id`	string
`invoice.line_items.subscription_id`	string
`invoice.line_items.customer_id`	string
`invoice.line_items.reference_line_item_id`	string
`invoice.line_items.tax_exempt_reason`	string
`invoice.line_items.discount_type`	number
`invoice.line_items.object`	string
`invoice.discounts`	objectarray
`invoice.discounts.id`	string
`invoice.discounts.invoice_name`	string
`invoice.discounts.type`	string
`invoice.discounts.percentage`	number
`invoice.discounts.amount`	number
`invoice.discounts.currency_code`	string
`invoice.discounts.duration_type`	string
`invoice.discounts.period`	number
`invoice.discounts.period_unit`	string
`invoice.discounts.included_in_mrr`	boolean
`invoice.discounts.apply_on`	string
`invoice.discounts.item_price_id`	string
`invoice.discounts.created_at`	number
`invoice.discounts.apply_till`	number
`invoice.discounts.object`	string
`invoice.line_item_discounts`	objectarray
`invoice.line_item_discounts.line_item_id`	string
`invoice.line_item_discounts.discount_type`	string
`invoice.line_item_discounts.coupon_id`	string
`invoice.line_item_discounts.entity_id`	string
`invoice.line_item_discounts.discount_amount`	number
`invoice.line_item_discounts.object`	string
`invoice.taxes`	objectarray
`invoice.taxes.name`	string
`invoice.taxes.amount`	number
`invoice.taxes.description`	string
`invoice.line_item_taxes`	objectarray
`invoice.line_item_taxes.line_item_id`	string
`invoice.line_item_taxes.tax_name`	string
`invoice.line_item_taxes.tax_rate`	number
`invoice.line_item_taxes.tax_amount`	number
`invoice.line_item_taxes.tax_juris_type`	string
`invoice.line_item_taxes.tax_juris_name`	string
`invoice.line_item_taxes.tax_juris_code`	string
`invoice.line_item_taxes.tax_amount_in_local_currency`	number
`invoice.line_item_taxes.local_currency_code`	string
`invoice.line_item_taxes.object`	string
`invoice.line_item_tiers`	objectarray
`invoice.line_item_tiers.line_item_id`	string
`invoice.line_item_tiers.starting_unit`	number
`invoice.line_item_tiers.ending_unit`	number
`invoice.line_item_tiers.quantity_used`	number
`invoice.line_item_tiers.unit_amount`	number
`invoice.line_item_tiers.starting_unit_in_decimal`	string
`invoice.line_item_tiers.ending_unit_in_decimal`	string
`invoice.line_item_tiers.quantity_used_in_decimal`	string
`invoice.line_item_tiers.unit_amount_in_decimal`	string
`invoice.line_item_tiers.pricing_type`	string
`invoice.line_item_tiers.package_size`	number
`invoice.line_item_tiers.object`	string
`invoice.linked_payments`	objectarray
`invoice.linked_payments.txn_id`	string
`invoice.linked_payments.applied_amount`	string
`invoice.linked_payments.applied_at`	number
`invoice.linked_payments.txn_status`	string
`invoice.linked_payments.txn_date`	number
`invoice.linked_payments.txn_amount`	number
`invoice.linked_payments.object`	string
`invoice.dunning_attempts`	objectarray
`invoice.dunning_attempts.attempt`	number
`invoice.dunning_attempts.transaction_id`	string
`invoice.dunning_attempts.dunning_type`	number
`invoice.dunning_attempts.created_at`	number
`invoice.dunning_attempts.txn_amount`	number
`invoice.dunning_attempts.txn_status`	string
`invoice.dunning_attempts.object`	string
`invoice.applied_credits`	objectarray
`invoice.applied_credits.cn_id`	string
`invoice.applied_credits.applied_amount`	string
`invoice.applied_credits.applied_at`	number
`invoice.applied_credits.cn_reason_code`	string
`invoice.applied_credits.cn_create_reason_code`	number
`invoice.applied_credits.cn_date`	number
`invoice.applied_credits.cn_status`	number
`invoice.applied_credits.object`	string
`invoice.adjustment_credit_notes`	objectarray
`invoice.adjustment_credit_notes.cn_id`	string
`invoice.adjustment_credit_notes.cn_reason_code`	string
`invoice.adjustment_credit_notes.cn_create_reason_code`	number
`invoice.adjustment_credit_notes.cn_date`	number
`invoice.adjustment_credit_notes.cn_total`	number
`invoice.adjustment_credit_notes.cn_status`	string
`invoice.adjustment_credit_notes.cn_reference_invoice_id`	number
`invoice.adjustment_credit_notes.object`	string
`invoice.issued_credit_notes`	objectarray
`invoice.issued_credit_notes.cn_id`	string
`invoice.issued_credit_notes.cn_reason_code`	string
`invoice.issued_credit_notes.cn_create_reason_code`	number
`invoice.issued_credit_notes.cn_date`	number
`invoice.issued_credit_notes.cn_total`	number
`invoice.issued_credit_notes.cn_status`	string
`invoice.issued_credit_notes.cn_reference_invoice_id`	number
`invoice.issued_credit_notes.object`	string
`invoice.linked_orders`	objectarray
`invoice.linked_orders.id`	string
`invoice.linked_orders.document_number`	string
`invoice.linked_orders.status`	string
`invoice.linked_orders.order_type`	string
`invoice.linked_orders.reference_id`	string
`invoice.linked_orders.fulfillment_status`	string
`invoice.linked_orders.batch_id`	string
`invoice.linked_orders.created_at`	number
`invoice.linked_orders.object`	string
`invoice.notes`	objectarray
`invoice.notes.entity_type`	string
`invoice.notes.note`	string
`invoice.notes.entity_id`	string
`invoice.notes.object`	string
`invoice.shipping_address`	object
`invoice.shipping_address.first_name`	string
`invoice.shipping_address.last_name`	string
`invoice.shipping_address.email`	string
`invoice.shipping_address.company`	string
`invoice.shipping_address.phone`	string
`invoice.shipping_address.line1`	string
`invoice.shipping_address.line2`	string
`invoice.shipping_address.line3`	string
`invoice.shipping_address.city`	string
`invoice.shipping_address.state_code`	string
`invoice.shipping_address.state`	string
`invoice.shipping_address.country`	string
`invoice.shipping_address.zip`	string
`invoice.shipping_address.validation_status`	string
`invoice.shipping_address.object`	string
`invoice.billing_address`	object
`invoice.billing_address.first_name`	string
`invoice.billing_address.last_name`	string
`invoice.billing_address.email`	string
`invoice.billing_address.company`	string
`invoice.billing_address.phone`	string
`invoice.billing_address.line1`	string
`invoice.billing_address.line2`	string
`invoice.billing_address.line3`	string
`invoice.billing_address.city`	string
`invoice.billing_address.state_code`	string
`invoice.billing_address.state`	string
`invoice.billing_address.country`	string
`invoice.billing_address.zip`	string
`invoice.billing_address.validation_status`	string
`invoice.billing_address.object`	string
`invoice.einvoice`	object
`invoice.einvoice.id`	string
`invoice.einvoice.reference_number`	string
`invoice.einvoice.status`	string
`invoice.einvoice.message`	string
`invoice.einvoice.object`	string

Item families — List item families

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`item_family`	object
`item_family.id`	string (Primary key)
`item_family.name`	string
`item_family.description`	string
`item_family.resource_version`	number
`item_family.updated_at`	number
`item_family.channel`	string
`item_family.status`	string
`item_family.business_entity_id`	string
`item_family.deleted`	boolean
`item_family.object`	string

Item prices — List item prices

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`item_price`	object
`item_price.id`	string (Primary key)
`item_price.name`	string
`item_price.item_family_id`	string
`item_price.item_id`	string
`item_price.description`	string
`item_price.status`	string
`item_price.external_name`	number
`item_price.pricing_model`	string
`item_price.price`	number
`item_price.price_in_decimal`	string
`item_price.period`	number
`item_price.currency_code`	string
`item_price.period_unit`	string
`item_price.trial_period_unit`	string
`item_price.trial_period`	number
`item_price.trial_end_action`	string
`item_price.shipping_period`	number
`item_price.shipping_period_unit`	string
`item_price.billing_cycles`	number
`item_price.free_quantity`	number
`item_price.free_quantity_in_decimal`	string
`item_price.resource_version`	number
`item_price.updated_at`	number
`item_price.invoice_notes`	string
`item_price.created_at`	number
`item_price.archived_at`	string
`item_price.unit`	number
`item_price.is_taxable`	boolean
`item_price.metered`	string
`item_price.show_description_in_invoices`	boolean
`item_price.show_description_in_quotes`	boolean
`item_price.deleted`	boolean
`item_price.object`	string
`item_price.channel`	string
`item_price.business_entity_id`	string
`item_price.tiers`	objectarray
`item_price.tiers.starting_unit`	number
`item_price.tiers.ending_unit`	number
`item_price.tiers.price`	number
`item_price.tiers.starting_unit_in_decimal`	string
`item_price.tiers.ending_unit_in_decimal`	string
`item_price.tiers.price_in_decimal`	string
`item_price.tiers.pricing_type`	string
`item_price.tiers.package_size`	number
`item_price.tax_detail`	object
`item_price.tax_detail.tax_profile_id`	string
`item_price.tax_detail.avalara_sale_type`	string
`item_price.tax_detail.avalara_transaction_type`	number
`item_price.tax_detail.avalara_service_type`	number
`item_price.tax_detail.avalara_tax_code`	string
`item_price.tax_detail.hsn_code`	string
`item_price.tax_detail.taxjar_product_code`	string
`item_price.tax_detail.tax_included_in_price`	string
`item_price.accounting_detail`	object
`item_price.accounting_detail.sku`	string
`item_price.accounting_detail.accounting_code`	string
`item_price.accounting_detail.accounting_category1`	string
`item_price.accounting_detail.accounting_category2`	string
`item_price.accounting_detail.accounting_category3`	string
`item_price.accounting_detail.accounting_category4`	string
`item_price.metadata`	object

Items — List items

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`item`	object
`item.id`	string (Primary key)
`item.name`	string
`item.external_name`	string
`item.description`	string
`item.status`	string
`item.resource_version`	number
`item.updated_at`	number
`item.item_family_id`	string
`item.type`	string
`item.is_shippable`	boolean
`item.is_giftable`	boolean
`item.redirect_url`	string
`item.enabled_for_checkout`	boolean
`item.enabled_in_portal`	boolean
`item.included_in_mrr`	string
`item.item_applicability`	string
`item.gift_claim_redirect_url`	string
`item.unit`	number
`item.metered`	boolean
`item.usage_calculation`	string
`item.deleted`	boolean
`item.object`	string
`item.channel`	string
`item.business_entity_id`	string
`item.applicable_items`	stringarray
`item.bundle_items`	stringarray
`item.bundle_configuration`	object
`item.bundle_configuration.type`	string
`item.metadata`	object

Omnichannel one time orders — List omnichannel one time orders

Response schema:

Field	Type
`omnichannel_one_time_order`	object
`omnichannel_one_time_order.id`	string (Primary key)
`omnichannel_one_time_order.app_id`	string
`omnichannel_one_time_order.customer_id`	string
`omnichannel_one_time_order.source`	string
`omnichannel_one_time_order.id_at_source`	string
`omnichannel_one_time_order.status`	string
`omnichannel_one_time_order.created_at`	number
`omnichannel_one_time_order.resource_version`	number
`omnichannel_one_time_order.updated_at`	number
`omnichannel_one_time_order.object`	string
`omnichannel_one_time_order.line_items`	objectarray
`omnichannel_one_time_order.line_items.id`	string
`omnichannel_one_time_order.line_items.id_at_source`	string
`omnichannel_one_time_order.line_items.item_id_at_source`	string
`omnichannel_one_time_order.line_items.quantity`	number
`omnichannel_one_time_order.line_items.purchased_at`	number
`omnichannel_one_time_order.line_items.object`	string

Omnichannel subscriptions — List omnichannel subscriptions

Response schema:

Field	Type
`omnichannel_subscription`	object
`omnichannel_subscription.id`	string (Primary key)
`omnichannel_subscription.app_id`	string
`omnichannel_subscription.customer_id`	string
`omnichannel_subscription.source`	string
`omnichannel_subscription.id_at_source`	string
`omnichannel_subscription.created_at`	number
`omnichannel_subscription.resource_version`	number
`omnichannel_subscription.updated_at`	number
`omnichannel_subscription.object`	string
`omnichannel_subscription.omnichannel_subscription_items`	objectarray
`omnichannel_subscription.omnichannel_subscription_items.id`	string
`omnichannel_subscription.omnichannel_subscription_items.id_at_source`	string
`omnichannel_subscription.omnichannel_subscription_items.item_id_at_source`	string
`omnichannel_subscription.omnichannel_subscription_items.status`	string
`omnichannel_subscription.omnichannel_subscription_items.current_term_start`	number
`omnichannel_subscription.omnichannel_subscription_items.current_term_end`	number
`omnichannel_subscription.omnichannel_subscription_items.expiration_date`	number
`omnichannel_subscription.omnichannel_subscription_items.object`	string

Orders — List orders

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`order`	object
`order.id`	string (Primary key)
`order.document_number`	string
`order.invoice_id`	string
`order.subscription_id`	string
`order.customer_id`	string
`order.status`	string
`order.reference_id`	string
`order.fulfillment_status`	string
`order.order_type`	string
`order.price_type`	string
`order.reference_invoice_id`	string
`order.tax`	number
`order.amount_paid`	number
`order.amount_adjusted`	number
`order.refundable_credits_issued`	number
`order.refundable_credits`	number
`order.batch_id`	string
`order.created_at`	number
`order.order_date`	number
`order.shipping_date`	number
`order.note`	string
`order.tracking_id`	string
`order.tracking_url`	string
`order.batch_id_at_shipping_provider`	string
`order.shipping_provider`	string
`order.resource_version`	number
`order.updated_at`	number
`order.delivered_at`	number
`order.shipped_at`	number
`order.order_line_items`	objectarray
`order.order_line_items.id`	string
`order.order_line_items.invoice_id`	string
`order.order_line_items.invoice_line_item_id`	string
`order.order_line_items.unit_price`	number
`order.order_line_items.amount`	number
`order.order_line_items.fulfillment_status`	string
`order.order_line_items.reference_id`	string
`order.order_line_items.sku`	string
`order.order_line_items.description`	string
`order.order_line_items.entity_type`	string
`order.order_line_items.entity_id`	string
`order.order_line_items.item_level_discount_id`	string
`order.order_line_items.tax_amount`	string
`order.order_line_items.amount_paid`	number
`order.order_line_items.amount_adjusted`	number
`order.order_line_items.refundable_credits`	number
`order.order_line_items.refundable_credits_issued`	number
`order.order_line_items.is_shippable`	string
`order.order_line_items.sku_id`	string
`order.order_line_items.status`	string
`order.order_line_items.discount_amount`	number
`order.order_line_items.object`	string
`order.currency_code`	string
`order.discount`	number
`order.sub_total`	number
`order.total`	number
`order.rounding_adjustement`	number
`order.deleted`	boolean
`order.object`	string
`order.gift_id`	string
`order.resend_status`	string
`order.is_resent`	string
`order.original_order_id`	string
`order.business_entity_id`	string
`order.base_currency_code`	string
`order.line_items`	objectarray
`order.line_items.id`	string
`order.line_items.date_from`	number
`order.line_items.date_to`	number
`order.line_items.unit_amount`	number
`order.line_items.quantity`	number
`order.line_items.amount`	number
`order.line_items.pricing_model`	number
`order.line_items.is_taxed`	boolean
`order.line_items.tax_amount`	number
`order.line_items.tax_rate`	number
`order.line_items.unit_amount_in_decimal`	number
`order.line_items.quantity_in_decimal`	string
`order.line_items.amount_in_decimal`	string
`order.line_items.discount_amount`	number
`order.line_items.item_level_discount_amount`	number
`order.line_items.description`	string
`order.line_items.entity_type`	string
`order.line_items.entity_id`	string
`order.line_items.subscription_id`	string
`order.line_items.customer_id`	string
`order.line_items.reference_line_item_id`	string
`order.line_items.tax_exempt_reason`	string
`order.line_items.discount_type`	number
`order.line_items.object`	string
`order.discounts`	objectarray
`order.discounts.id`	string
`order.discounts.invoice_name`	string
`order.discounts.type`	string
`order.discounts.percentage`	number
`order.discounts.amount`	number
`order.discounts.currency_code`	string
`order.discounts.duration_type`	string
`order.discounts.period`	number
`order.discounts.period_unit`	string
`order.discounts.included_in_mrr`	boolean
`order.discounts.apply_on`	string
`order.discounts.item_price_id`	string
`order.discounts.created_at`	number
`order.discounts.apply_till`	number
`order.discounts.object`	string
`order.taxes`	objectarray
`order.taxes.name`	string
`order.taxes.amount`	number
`order.taxes.description`	string
`order.line_item_taxes`	objectarray
`order.line_item_taxes.line_item_id`	string
`order.line_item_taxes.tax_name`	string
`order.line_item_taxes.tax_rate`	number
`order.line_item_taxes.tax_amount`	number
`order.line_item_taxes.tax_juris_type`	string
`order.line_item_taxes.tax_juris_name`	string
`order.line_item_taxes.tax_juris_code`	string
`order.line_item_taxes.tax_amount_in_local_currency`	number
`order.line_item_taxes.local_currency_code`	string
`order.line_item_taxes.object`	string
`order.line_item_discounts`	objectarray
`order.line_item_discounts.line_item_id`	string
`order.line_item_discounts.discount_type`	string
`order.line_item_discounts.coupon_id`	string
`order.line_item_discounts.entity_id`	string
`order.line_item_discounts.discount_amount`	number
`order.line_item_discounts.object`	string
`order.linked_credit_notes`	objectarray
`order.linked_credit_notes.id`	string
`order.linked_credit_notes.amount`	number
`order.linked_credit_notes.date`	number
`order.linked_credit_notes.type`	string
`order.linked_credit_notes.status`	string
`order.linked_credit_notes.amount_available`	string
`order.linked_credit_notes.reference_invoice_id`	string
`order.linked_credit_notes.cn_reason_code`	string
`order.linked_credit_notes.cn_create_reason_code`	number
`order.linked_credit_notes.object`	string
`order.shipping_address`	object
`order.shipping_address.first_name`	string
`order.shipping_address.last_name`	string
`order.shipping_address.email`	string
`order.shipping_address.company`	string
`order.shipping_address.phone`	string
`order.shipping_address.line1`	string
`order.shipping_address.line2`	string
`order.shipping_address.line3`	string
`order.shipping_address.city`	string
`order.shipping_address.state_code`	string
`order.shipping_address.state`	string
`order.shipping_address.country`	string
`order.shipping_address.zip`	string
`order.shipping_address.validation_status`	string
`order.shipping_address.object`	string
`order.billing_address`	object
`order.billing_address.first_name`	string
`order.billing_address.last_name`	string
`order.billing_address.email`	string
`order.billing_address.company`	string
`order.billing_address.phone`	string
`order.billing_address.line1`	string
`order.billing_address.line2`	string
`order.billing_address.line3`	string
`order.billing_address.city`	string
`order.billing_address.state_code`	string
`order.billing_address.state`	string
`order.billing_address.country`	string
`order.billing_address.zip`	string
`order.billing_address.validation_status`	string
`order.billing_address.object`	string

Payment sources — List payment sources

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`payment_source`	object
`payment_source.id`	string (Primary key)
`payment_source.customer_id`	string
`payment_source.type`	string
`payment_source.reference_id`	string
`payment_source.status`	string
`payment_source.gateway`	string
`payment_source.gateway_account_id`	string
`payment_source.ip_address`	string
`payment_source.issuing_country`	string
`payment_source.created_at`	number
`payment_source.updated_at`	number
`payment_source.resource_version`	number
`payment_source.deleted`	boolean
`payment_source.object`	string
`payment_source.business_entity_id`	string
`payment_source.card`	object
`payment_source.card.first_name`	string
`payment_source.card.last_name`	string
`payment_source.card.iin`	string
`payment_source.card.last4`	string
`payment_source.card.funding_type`	string
`payment_source.card.expiry_month`	string
`payment_source.card.expiry_year`	string
`payment_source.card.billing_addr1`	string
`payment_source.card.billing_addr2`	string
`payment_source.card.billing_city`	string
`payment_source.card.billing_state_code`	string
`payment_source.card.billing_state`	string
`payment_source.card.billing_country`	string
`payment_source.card.billing_zip`	string
`payment_source.card.masked_number`	string
`payment_source.card.object`	string
`payment_source.card.brand`	string
`payment_source.bank_account`	object
`payment_source.bank_account.last4`	string
`payment_source.bank_account.name_on_account`	string
`payment_source.bank_account.bank_name`	string
`payment_source.bank_account.mandate_id`	string
`payment_source.bank_account.account_type`	string
`payment_source.bank_account.echeck_type`	string
`payment_source.bank_account.account_holder_type`	string
`payment_source.bank_account.email`	string
`payment_source.amazon_payment`	object
`payment_source.amazon_payment.email`	string
`payment_source.amazon_payment.agreement_id`	string
`payment_source.paypal`	object
`payment_source.paypal.email`	string
`payment_source.paypal.agreement_id`	string
`payment_source.mandates`	objectarray
`payment_source.mandates.id`	string
`payment_source.mandates.subscription_id`	string
`payment_source.mandates.created_at`	number

Price variants — List price variants

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`price_variant`	object
`price_variant.id`	string (Primary key)
`price_variant.name`	string
`price_variant.description`	string
`price_variant.status`	string
`price_variant.external_name`	string
`price_variant.created_at`	number
`price_variant.updated_at`	number
`price_variant.resource_version`	number
`price_variant.object`	string
`price_variant.business_entity_id`	string

Products — List products

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`product`	object
`product.id`	string (Primary key)
`product.name`	string
`product.description`	string
`product.status`	string
`product.created_at`	number
`product.updated_at`	number
`product.resource_version`	number
`product.object`	string

Promotional credits — List promotional credits

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`created_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`promotional_credit`	object
`promotional_credit.id`	string (Primary key)
`promotional_credit.customer_id`	string
`promotional_credit.type`	string
`promotional_credit.amount`	number
`promotional_credit.description`	string
`promotional_credit.credit_type`	string
`promotional_credit.reference`	string
`promotional_credit.closing_balance`	number
`promotional_credit.done_by`	string
`promotional_credit.created_at`	number
`promotional_credit.object`	string
`promotional_credit.currency_code`	string
`promotional_credit.amount_in_decimal`	string

Quotes — List quotes

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`quote`	object
`quote.id`	string (Primary key)
`quote.name`	string
`quote.po_number`	string
`quote.customer_id`	string
`quote.subscription_id`	string
`quote.invoice_id`	string
`quote.status`	string
`quote.operation_type`	string
`quote.vat_number`	string
`quote.price_type`	number
`quote.valid_till`	number
`quote.date`	number
`quote.total_payable`	number
`quote.charge_on_acceptance`	number
`quote.sub_total`	number
`quote.total`	number
`quote.credits_applied`	number
`quote.amount_paid`	number
`quote.amount_due`	number
`quote.version`	string
`quote.resource_version`	number
`quote.updated_at`	number
`quote.taxes_inclusive`	boolean
`quote.line_items`	objectarray
`quote.line_items.id`	string
`quote.line_items.date_from`	number
`quote.line_items.date_to`	number
`quote.line_items.unit_amount`	number
`quote.line_items.quantity`	number
`quote.line_items.amount`	number
`quote.line_items.pricing_model`	number
`quote.line_items.is_taxed`	boolean
`quote.line_items.tax_amount`	number
`quote.line_items.tax_rate`	number
`quote.line_items.unit_amount_in_decimal`	number
`quote.line_items.quantity_in_decimal`	string
`quote.line_items.amount_in_decimal`	string
`quote.line_items.discount_amount`	number
`quote.line_items.item_level_discount_amount`	number
`quote.line_items.description`	string
`quote.line_items.entity_type`	string
`quote.line_items.entity_id`	string
`quote.line_items.subscription_id`	string
`quote.line_items.customer_id`	string
`quote.line_items.reference_line_item_id`	string
`quote.line_items.tax_exempt_reason`	string
`quote.line_items.discount_type`	number
`quote.line_items.object`	string
`quote.currency_code`	string
`quote.notes`	string
`quote.expiry_date`	number
`quote.vat_number_prefix`	string
`quote.business_entity_id`	string
`quote.deleted`	boolean
`quote.object`	string
`quote.base_currency_code`	string
`quote.contract_term_start`	string
`quote.contract_term_end`	string
`quote.discounts`	objectarray
`quote.discounts.id`	string
`quote.discounts.invoice_name`	string
`quote.discounts.type`	string
`quote.discounts.percentage`	number
`quote.discounts.amount`	number
`quote.discounts.currency_code`	string
`quote.discounts.duration_type`	string
`quote.discounts.period`	number
`quote.discounts.period_unit`	string
`quote.discounts.included_in_mrr`	boolean
`quote.discounts.apply_on`	string
`quote.discounts.item_price_id`	string
`quote.discounts.created_at`	number
`quote.discounts.apply_till`	number
`quote.discounts.object`	string
`quote.line_item_discounts`	objectarray
`quote.line_item_discounts.line_item_id`	string
`quote.line_item_discounts.discount_type`	string
`quote.line_item_discounts.coupon_id`	string
`quote.line_item_discounts.entity_id`	string
`quote.line_item_discounts.discount_amount`	number
`quote.line_item_discounts.object`	string
`quote.taxes`	objectarray
`quote.taxes.name`	string
`quote.taxes.amount`	number
`quote.taxes.description`	string
`quote.line_item_taxes`	objectarray
`quote.line_item_taxes.line_item_id`	string
`quote.line_item_taxes.tax_name`	string
`quote.line_item_taxes.tax_rate`	number
`quote.line_item_taxes.tax_amount`	number
`quote.line_item_taxes.tax_juris_type`	string
`quote.line_item_taxes.tax_juris_name`	string
`quote.line_item_taxes.tax_juris_code`	string
`quote.line_item_taxes.tax_amount_in_local_currency`	number
`quote.line_item_taxes.local_currency_code`	string
`quote.line_item_taxes.object`	string
`quote.line_item_tiers`	objectarray
`quote.line_item_tiers.line_item_id`	string
`quote.line_item_tiers.starting_unit`	number
`quote.line_item_tiers.ending_unit`	number
`quote.line_item_tiers.quantity_used`	number
`quote.line_item_tiers.unit_amount`	number
`quote.line_item_tiers.starting_unit_in_decimal`	string
`quote.line_item_tiers.ending_unit_in_decimal`	string
`quote.line_item_tiers.quantity_used_in_decimal`	string
`quote.line_item_tiers.unit_amount_in_decimal`	string
`quote.line_item_tiers.pricing_type`	string
`quote.line_item_tiers.package_size`	number
`quote.line_item_tiers.object`	string
`quote.shipping_address`	object
`quote.shipping_address.first_name`	string
`quote.shipping_address.last_name`	string
`quote.shipping_address.email`	string
`quote.shipping_address.company`	string
`quote.shipping_address.phone`	string
`quote.shipping_address.line1`	string
`quote.shipping_address.line2`	string
`quote.shipping_address.line3`	string
`quote.shipping_address.city`	string
`quote.shipping_address.state_code`	string
`quote.shipping_address.state`	string
`quote.shipping_address.country`	string
`quote.shipping_address.zip`	string
`quote.shipping_address.validation_status`	string
`quote.shipping_address.object`	string
`quote.billing_address`	object
`quote.billing_address.first_name`	string
`quote.billing_address.last_name`	string
`quote.billing_address.email`	string
`quote.billing_address.company`	string
`quote.billing_address.phone`	string
`quote.billing_address.line1`	string
`quote.billing_address.line2`	string
`quote.billing_address.line3`	string
`quote.billing_address.city`	string
`quote.billing_address.state_code`	string
`quote.billing_address.state`	string
`quote.billing_address.country`	string
`quote.billing_address.zip`	string
`quote.billing_address.validation_status`	string
`quote.billing_address.object`	string

Ramps — List subscription ramps

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`ramp`	object
`ramp.id`	string (Primary key)
`ramp.subscription_id`	string
`ramp.effective_from`	number
`ramp.status`	string
`ramp.created_at`	number
`ramp.updated_at`	number
`ramp.resource_version`	number
`ramp.description`	string
`ramp.object`	string
`ramp.item_prices`	objectarray
`ramp.item_prices.item_price_id`	string
`ramp.item_prices.item_type`	string
`ramp.item_prices.quantity`	number
`ramp.item_prices.quantity_in_decimal`	string
`ramp.item_prices.unit_price`	number
`ramp.item_prices.unit_price_in_decimal`	string
`ramp.item_prices.billing_period`	number
`ramp.item_prices.billing_period_unit`	string
`ramp.item_prices.object`	string
`ramp.discounts`	objectarray
`ramp.discounts.id`	string
`ramp.discounts.invoice_name`	string
`ramp.discounts.type`	string
`ramp.discounts.percentage`	number
`ramp.discounts.amount`	number
`ramp.discounts.currency_code`	string
`ramp.discounts.duration_type`	string
`ramp.discounts.period`	number
`ramp.discounts.period_unit`	string
`ramp.discounts.included_in_mrr`	boolean
`ramp.discounts.apply_on`	string
`ramp.discounts.item_price_id`	string
`ramp.discounts.created_at`	number
`ramp.discounts.apply_till`	number
`ramp.discounts.object`	string
`ramp.coupons`	objectarray
`ramp.coupons.coupon_id`	string
`ramp.coupons.object`	string
`ramp.item_tiers`	objectarray
`ramp.item_tiers.item_price_id`	string
`ramp.item_tiers.starting_unit`	number
`ramp.item_tiers.ending_unit`	number
`ramp.item_tiers.price`	number
`ramp.item_tiers.object`	string

Subscriptions — List subscriptions

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`subscription`	object
`subscription.id`	string (Primary key)
`subscription.currency_code`	string
`subscription.start_date`	number
`subscription.trial_end`	number
`subscription.remaining_billing_cycles`	number
`subscription.po_number`	string
`subscription.customer_id`	string
`subscription.plan_id`	number
`subscription.plan_quantity`	number
`subscription.plan_unit_price`	number
`subscription.plan_amount`	number
`subscription.billing_period`	number
`subscription.billing_period_unit`	string
`subscription.plan_free_quantity`	number
`subscription.status`	string
`subscription.trial_start`	number
`subscription.trial_end_action`	string
`subscription.current_term_start`	number
`subscription.current_term_end`	number
`subscription.next_billing_at`	number
`subscription.created_at`	number
`subscription.started_at`	number
`subscription.activated_at`	number
`subscription.gift_id`	string
`subscription.override_relationship`	boolean
`subscription.pause_date`	number
`subscription.resume_date`	number
`subscription.contract_term_billing_cycle_on_renewal`	number
`subscription.created_from_ip`	string
`subscription.resource_version`	number
`subscription.updated_at`	number
`subscription.has_scheduled_changes`	boolean
`subscription.has_scheduled_advance_invoices`	boolean
`subscription.payment_source_id`	string
`subscription.plan_free_quantity_in_decimal`	string
`subscription.plan_amount_in_decimal`	string
`subscription.cancel_reason`	string
`subscription.cancelled_at`	number
`subscription.cancel_schedule_created_at`	number
`subscription.offline_payment_method`	string
`subscription.channel`	string
`subscription.net_term_days`	number
`subscription.active_id`	string
`subscription.due_invoices_count`	number
`subscription.due_since`	number
`subscription.total_dues`	number
`subscription.mrr`	number
`subscription.exchange_rate`	number
`subscription.base_currency_code`	string
`subscription.invoice_notes`	string
`subscription.deleted`	boolean
`subscription.object`	string
`subscription.coupon`	string
`subscription.auto_collection`	string
`subscription.due_compliant`	boolean
`subscription.business_entity_id`	string
`subscription.brand_identifier`	string
`subscription.create_pending_invoices`	boolean
`subscription.auto_close_invoices`	boolean
`subscription.cancel_reason_code`	string
`subscription.free_period`	number
`subscription.free_period_unit`	string
`subscription.changes_scheduled_at`	number
`subscription.subscription_items`	objectarray
`subscription.subscription_items.item_price_id`	string
`subscription.subscription_items.item_type`	string
`subscription.subscription_items.quantity`	number
`subscription.subscription_items.quantity_in_decimal`	string
`subscription.subscription_items.metered_quantity`	string
`subscription.subscription_items.unit_price`	number
`subscription.subscription_items.unit_price_in_decimal`	string
`subscription.subscription_items.amount`	number
`subscription.subscription_items.amount_in_decimal`	string
`subscription.subscription_items.free_quantity`	number
`subscription.subscription_items.free_quantity_in_decimal`	string
`subscription.subscription_items.trial_end`	number
`subscription.subscription_items.billing_cycles`	number
`subscription.subscription_items.service_period_days`	number
`subscription.subscription_items.charge_on_event`	string
`subscription.subscription_items.charge_once`	boolean
`subscription.subscription_items.charge_on_option`	string
`subscription.subscription_items.proration_type`	string
`subscription.subscription_items.installment_number`	number
`subscription.subscription_items.object`	string
`subscription.item_tiers`	objectarray
`subscription.item_tiers.item_price_id`	string
`subscription.item_tiers.starting_unit`	number
`subscription.item_tiers.ending_unit`	number
`subscription.item_tiers.price`	number
`subscription.item_tiers.starting_unit_in_decimal`	string
`subscription.item_tiers.ending_unit_in_decimal`	string
`subscription.item_tiers.price_in_decimal`	string
`subscription.item_tiers.pricing_type`	string
`subscription.item_tiers.package_size`	number
`subscription.charged_items`	objectarray
`subscription.charged_items.item_price_id`	string
`subscription.charged_items.last_charged_at`	number
`subscription.coupons`	objectarray
`subscription.coupons.coupon_id`	string
`subscription.coupons.apply_till`	number
`subscription.coupons.applied_count`	number
`subscription.coupons.coupon_code`	string
`subscription.coupons.object`	string
`subscription.shipping_address`	object
`subscription.shipping_address.first_name`	string
`subscription.shipping_address.last_name`	string
`subscription.shipping_address.email`	string
`subscription.shipping_address.company`	string
`subscription.shipping_address.phone`	string
`subscription.shipping_address.line1`	string
`subscription.shipping_address.line2`	string
`subscription.shipping_address.line3`	string
`subscription.shipping_address.city`	string
`subscription.shipping_address.state_code`	string
`subscription.shipping_address.state`	string
`subscription.shipping_address.country`	string
`subscription.shipping_address.zip`	string
`subscription.shipping_address.validation_status`	string
`subscription.shipping_address.object`	string
`subscription.contract_term`	object
`subscription.contract_term.id`	string
`subscription.contract_term.status`	string
`subscription.contract_term.contract_start`	number
`subscription.contract_term.contract_end`	number
`subscription.contract_term.billing_cycle`	number
`subscription.contract_term.action_at_term_end`	string
`subscription.contract_term.total_contract_value`	number
`subscription.contract_term.total_contract_value_before_tax`	number
`subscription.contract_term.cancellation_cutoff_period`	number
`subscription.contract_term.created_at`	number
`subscription.contract_term.subscription_id`	string
`subscription.contract_term.remaining_billing_cycles`	number
`subscription.contract_term.object`	string
`subscription.referral_info`	object
`subscription.referral_info.referral_code`	string
`subscription.referral_info.coupon_code`	string
`subscription.referral_info.referrer_id`	string
`subscription.referral_info.external_reference_id`	string
`subscription.referral_info.reward_status`	string
`subscription.referral_info.referral_system`	string
`subscription.referral_info.account_id`	string
`subscription.referral_info.campaign_id`	string
`subscription.referral_info.external_campaign_id`	string
`subscription.referral_info.friend_offer_type`	string
`subscription.referral_info.referrer_reward_type`	string
`subscription.referral_info.notify_referral_system`	string
`subscription.referral_info.destination_url`	string
`subscription.referral_info.post_purchase_widget_enabled`	boolean
`subscription.discounts`	objectarray
`subscription.discounts.id`	string
`subscription.discounts.invoice_name`	string
`subscription.discounts.type`	string
`subscription.discounts.percentage`	number
`subscription.discounts.amount`	number
`subscription.discounts.currency_code`	string
`subscription.discounts.duration_type`	string
`subscription.discounts.period`	number
`subscription.discounts.period_unit`	string
`subscription.discounts.included_in_mrr`	boolean
`subscription.discounts.apply_on`	string
`subscription.discounts.item_price_id`	string
`subscription.discounts.created_at`	number
`subscription.discounts.apply_till`	number
`subscription.discounts.object`	string
`subscription.meta_data`	object

Transactions — List transactions

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`transaction`	object
`transaction.id`	string (Primary key)
`transaction.customer_id`	string
`transaction.subscription_id`	string
`transaction.gateway_account_id`	string
`transaction.payment_source_id`	string
`transaction.payment_method`	string
`transaction.reference_number`	string
`transaction.gateway`	string
`transaction.type`	string
`transaction.date`	number
`transaction.settled_at`	number
`transaction.exchange_rate`	number
`transaction.currency_code`	string
`transaction.amount`	number
`transaction.id_at_gateway`	string
`transaction.status`	string
`transaction.fraud_flag`	string
`transaction.initiator_type`	string
`transaction.three_d_secure`	number
`transaction.authorization_reason`	string
`transaction.error_code`	string
`transaction.error_text`	string
`transaction.voided_at`	number
`transaction.resource_version`	number
`transaction.updated_at`	number
`transaction.amount_unused`	number
`transaction.masked_card_number`	string
`transaction.reference_transaction_id`	string
`transaction.refunded_txn_id`	string
`transaction.reference_authorization_id`	string
`transaction.amount_capturable`	number
`transaction.reversal_transaction_id`	boolean
`transaction.deleted`	boolean
`transaction.object`	string
`transaction.gateway_settlement_key`	string
`transaction.payment_method_details`	string
`transaction.business_entity_id`	string
`transaction.base_currency_code`	string
`transaction.linked_invoices`	objectarray
`transaction.linked_invoices.invoice_id`	string
`transaction.linked_invoices.applied_amount`	string
`transaction.linked_invoices.applied_at`	number
`transaction.linked_invoices.invoice_date`	number
`transaction.linked_invoices.invoice_total`	number
`transaction.linked_invoices.invoice_status`	string
`transaction.linked_invoices.object`	string
`transaction.linked_credit_notes`	objectarray
`transaction.linked_credit_notes.cn_id`	string
`transaction.linked_credit_notes.applied_amount`	string
`transaction.linked_credit_notes.applied_at`	number
`transaction.linked_credit_notes.cn_reason_code`	string
`transaction.linked_credit_notes.cn_create_reason_code`	number
`transaction.linked_credit_notes.cn_date`	number
`transaction.linked_credit_notes.cn_total`	number
`transaction.linked_credit_notes.cn_status`	string
`transaction.linked_credit_notes.cn_reference_invoice_id`	string
`transaction.linked_credit_notes.object`	string
`transaction.linked_refunds`	objectarray
`transaction.linked_refunds.txn_id`	string
`transaction.linked_refunds.txn_status`	string
`transaction.linked_refunds.txn_date`	number
`transaction.linked_refunds.txn_amount`	number
`transaction.linked_refunds.object`	string
`transaction.linked_payments`	objectarray
`transaction.linked_payments.id`	string
`transaction.linked_payments.status`	string
`transaction.linked_payments.amount`	number
`transaction.linked_payments.date`	number
`transaction.linked_payments.object`	string

Unbilled charges — List unbilled charges

Response schema:

Field	Type
`unbilled_charge`	object
`unbilled_charge.id`	string (Primary key)
`unbilled_charge.customer_id`	string
`unbilled_charge.subscription_id`	string
`unbilled_charge.date_from`	number
`unbilled_charge.date_to`	number
`unbilled_charge.unit_amount`	number
`unbilled_charge.pricing_model`	string
`unbilled_charge.quantity`	number
`unbilled_charge.amount`	number
`unbilled_charge.currency_code`	string
`unbilled_charge.discount_amount`	number
`unbilled_charge.description`	string
`unbilled_charge.entity_type`	string
`unbilled_charge.entity_id`	string
`unbilled_charge.is_voided`	boolean
`unbilled_charge.voided_at`	number
`unbilled_charge.updated_at`	number
`unbilled_charge.resource_version`	number
`unbilled_charge.deleted`	boolean
`unbilled_charge.object`	string
`unbilled_charge.quantity_in_decimal`	string
`unbilled_charge.unit_amount_in_decimal`	string
`unbilled_charge.amount_in_decimal`	string
`unbilled_charge.discount_type`	number
`unbilled_charge.subscription_currency_code`	string
`unbilled_charge.tiers`	objectarray
`unbilled_charge.tiers.starting_unit`	number
`unbilled_charge.tiers.ending_unit`	number
`unbilled_charge.tiers.quantity_used`	number
`unbilled_charge.tiers.unit_amount`	number
`unbilled_charge.tiers.object`	string
`unbilled_charge.line_item_tiers`	objectarray
`unbilled_charge.line_item_tiers.line_item_id`	string
`unbilled_charge.line_item_tiers.starting_unit`	number
`unbilled_charge.line_item_tiers.ending_unit`	number
`unbilled_charge.line_item_tiers.quantity_used`	number
`unbilled_charge.line_item_tiers.unit_amount`	number
`unbilled_charge.line_item_tiers.starting_unit_in_decimal`	string
`unbilled_charge.line_item_tiers.ending_unit_in_decimal`	string
`unbilled_charge.line_item_tiers.quantity_used_in_decimal`	string
`unbilled_charge.line_item_tiers.unit_amount_in_decimal`	string
`unbilled_charge.line_item_tiers.pricing_type`	string
`unbilled_charge.line_item_tiers.package_size`	number
`unbilled_charge.line_item_tiers.object`	string

Usages — List usages

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`usage`	object
`usage.id`	string (Primary key)
`usage.subscription_id`	string
`usage.item_price_id`	string
`usage.quantity`	number
`usage.quantity_in_decimal`	string
`usage.usage_date`	number
`usage.source`	string
`usage.note`	string
`usage.created_at`	number
`usage.updated_at`	number
`usage.resource_version`	number
`usage.line_item_id`	string
`usage.deleted`	boolean
`usage.object`	string

Virtual bank accounts — List virtual bank accountss

Delta configuration: use it to request incremental data.

Setting	Value
Delta filter	`updated_at[after] = {{{encodeURI lastExportDateTime}}}`
Date format	`X`

Response schema:

Field	Type
`virtual_bank_account`	object
`virtual_bank_account.id`	string (Primary key)
`virtual_bank_account.customer_id`	string
`virtual_bank_account.email`	string
`virtual_bank_account.scheme`	string
`virtual_bank_account.bank_name`	string
`virtual_bank_account.account_number`	string
`virtual_bank_account.routing_number`	string
`virtual_bank_account.swift_code`	string
`virtual_bank_account.gateway`	string
`virtual_bank_account.gateway_account_id`	string
`virtual_bank_account.resource_version`	string
`virtual_bank_account.updated_at`	number
`virtual_bank_account.created_at`	number
`virtual_bank_account.reference_id`	string
`virtual_bank_account.iban`	string
`virtual_bank_account.deleted`	boolean
`virtual_bank_account.object`	string
`virtual_bank_account.account_type`	string
`virtual_bank_account.account_holder_name`	string

Note

Available DI objects

Note

Response schemas

Can't find what you're looking for?