activate_subscription
ChatGPTManually activate a pending subscription, starting its first billing period immediately.
activate_subscription
ChatGPTManually activate a pending subscription, starting its first billing period immediately.
approve_quote
ChatGPTApprove a quote as the account owner. This is a prerequisite before sending the quote for customer signature.
approve_quote
ChatGPTApprove a quote as the account owner. This is a prerequisite before sending the quote for customer signature.
archive_customer
ChatGPTArchive a customer by ID. Archived customers are hidden from default list views but can be restored.
archive_customer
ChatGPTArchive a customer by ID. Archived customers are hidden from default list views but can be restored.
archive_product
ChatGPTArchive a product by ID. Archived products cannot be added to new subscriptions but remain on existing ones.
archive_product
ChatGPTArchive a product by ID. Archived products cannot be added to new subscriptions but remain on existing ones.
bulk_update_customers_providers
ChatGPTBulk update provider mappings for multiple customers. Optionally sync payment methods from connected PSPs. Check the response for per-customer success/failure status.
bulk_update_customers_providers
ChatGPTBulk update provider mappings for multiple customers. Optionally sync payment methods from connected PSPs. Check the response for per-customer success/failure status.
cancel_subscription
ChatGPTCancel a subscription. Supports immediate or end-of-period cancellation. Optionally specify a cancellation reason.
cancel_subscription
ChatGPTCancel a subscription. Supports immediate or end-of-period cancellation. Optionally specify a cancellation reason.
cancel_subscription_transition
ChatGPTCancel a scheduled subscription transition before it is applied.
cancel_subscription_transition
ChatGPTCancel a scheduled subscription transition before it is applied.
charge_invoice
ChatGPTManually trigger payment collection for an invoice. Optionally specify a payment_method_id to charge.
charge_invoice
ChatGPTManually trigger payment collection for an invoice. Optionally specify a payment_method_id to charge.
create_company
ChatGPTCreate a new company. The authentication token will automatically get access to the newly created company.
create_company
ChatGPTCreate a new company. The authentication token will automatically get access to the newly created company.
create_coupon
ChatGPTCreate a new coupon with discount rules. Supports percentage or fixed amount discounts, duration limits, and redemption restrictions.
create_coupon
ChatGPTCreate a new coupon with discount rules. Supports percentage or fixed amount discounts, duration limits, and redemption restrictions.
create_credit_note
ChatGPTCreate a credit note for an existing invoice by ID. Credit notes partially or fully reverse an invoice amount. Optionally trigger a refund via wallet, original payment method, or external settlement.
create_credit_note
ChatGPTCreate a credit note for an existing invoice by ID. Credit notes partially or fully reverse an invoice amount. Optionally trigger a refund via wallet, original payment method, or external settlement.
create_custom_property
ChatGPTCreate a new custom property definition with a name, type (string, number, boolean, date, select), and optional default value.
create_custom_property
ChatGPTCreate a new custom property definition with a name, type (string, number, boolean, date, select), and optional default value.
create_customer
ChatGPTCreate a new customer with billing details, address, currency, and optional provider mappings. Returns the full customer object.
create_customer
ChatGPTCreate a new customer with billing details, address, currency, and optional provider mappings. Returns the full customer object.
create_customer_credit
ChatGPTCreate a credit entity for a customer linked to a specific product with an optional initial balance.
create_customer_credit
ChatGPTCreate a credit entity for a customer linked to a specific product with an optional initial balance.
create_customer_credits_usage
ChatGPTRecord credit usage for a customer's credit product. Deducts the specified usage_retained amount from the balance.
create_customer_credits_usage
ChatGPTRecord credit usage for a customer's credit product. Deducts the specified usage_retained amount from the balance.
create_customer_payment_method
ChatGPTImport an existing payment method from a connected payment provider (e.g. Stripe) for a customer.
create_customer_payment_method
ChatGPTImport an existing payment method from a connected payment provider (e.g. Stripe) for a customer.
create_customers
ChatGPTCreate up to 50 customers in a single batch request. Returns successes and errors separately for each customer in the batch.
create_customers
ChatGPTCreate up to 50 customers in a single batch request. Returns successes and errors separately for each customer in the batch.
create_customers_segment
ChatGPTCreate a new customer segment.
create_customers_segment
ChatGPTCreate a new customer segment.
create_export
ChatGPTPrepare a data export (customers, invoices, etc.) for download. Check export status via get_export, then download via download_export once ready.
create_export
ChatGPTPrepare a data export (customers, invoices, etc.) for download. Check export status via get_export, then download via download_export once ready.
create_file
ChatGPTUpload a new file (max 10MB). Requires multipart form data with a file field and metadata (name, optional customer_id).
create_file
ChatGPTUpload a new file (max 10MB). Requires multipart form data with a file field and metadata (name, optional customer_id).
create_invoice
ChatGPTCreate a new invoice for a customer with line items, due date, and billing configuration. Returns the full invoice object.
create_invoice
ChatGPTCreate a new invoice for a customer with line items, due date, and billing configuration. Returns the full invoice object.
create_invoice_transaction
ChatGPTRecord a payment transaction on an invoice. May update the invoice status to paid or partially_paid depending on the amount.
create_invoice_transaction
ChatGPTRecord a payment transaction on an invoice. May update the invoice status to paid or partially_paid depending on the amount.
create_invoices
ChatGPTCreate multiple invoices asynchronously in batch. Track results via webhooks (invoice.batch.creation_succeeded / invoice.batch.creation_failed). Returns a batch_id.
create_invoices
ChatGPTCreate multiple invoices asynchronously in batch. Track results via webhooks (invoice.batch.creation_succeeded / invoice.batch.creation_failed). Returns a batch_id.
create_invoicing_entity
ChatGPTCreate a new invoicing entity with company details, address, and tax configuration. Used as the sender on invoices.
create_invoicing_entity
ChatGPTCreate a new invoicing entity with company details, address, and tax configuration. Used as the sender on invoices.
create_payment
ChatGPTInitiate a one-time payment: generates an invoice and charges it directly or via a checkout session. Returns references to the created invoice and optional checkout URL.
create_payment
ChatGPTInitiate a one-time payment: generates an invoice and charges it directly or via a checkout session. Returns references to the created invoice and optional checkout URL.
create_product
ChatGPTCreate a new product with name, type (flat_fee, per_unit, usage, seat, etc.), and pricing configuration.
create_product
ChatGPTCreate a new product with name, type (flat_fee, per_unit, usage, seat, etc.), and pricing configuration.
create_promotion_code
ChatGPTCreate a new promotion code linked to an existing coupon. The code can be shared with customers for self-service discount application.
create_promotion_code
ChatGPTCreate a new promotion code linked to an existing coupon. The code can be shared with customers for self-service discount application.
create_quote
ChatGPTCreate a new quote for a customer. Use subscription (or template_id) for subscription quotes; use invoice for one-off quotes backed by a draft invoice with line items. Quotes can be sent for signature and converted to subscriptions or one-off invoices.
create_quote
ChatGPTCreate a new quote for a customer. Use subscription (or template_id) for subscription quotes; use invoice for one-off quotes backed by a draft invoice with line items. Quotes can be sent for signature and converted to subscriptions or one-off invoices.
create_subscription
ChatGPTCreate a new subscription from a template, plan, or manually with products and phases. Requires a customer_id and at least one of: template_id, template_configuration_id, products, or phases.
create_subscription
ChatGPTCreate a new subscription from a template, plan, or manually with products and phases. Requires a customer_id and at least one of: template_id, template_configuration_id, products, or phases.
create_subscription_transition
ChatGPTCreate a transition from one subscription to another, configured from a subscription, plan, or template. Can be applied immediately or scheduled.
create_subscription_transition
ChatGPTCreate a transition from one subscription to another, configured from a subscription, plan, or template. Can be applied immediately or scheduled.
create_subscription_update
ChatGPTApply a single update to an existing subscription (e.g. change quantity, add/remove product, modify price).
create_subscription_update
ChatGPTApply a single update to an existing subscription (e.g. change quantity, add/remove product, modify price).
create_subscription_updates
ChatGPTApply multiple updates at once to an existing subscription in a single atomic operation.
create_subscription_updates
ChatGPTApply multiple updates at once to an existing subscription in a single atomic operation.
create_wallet
ChatGPTCreate a new prepaid wallet for a customer with an initial balance and currency.
create_wallet
ChatGPTCreate a new prepaid wallet for a customer with an initial balance and currency.
create_webhook_endpoint
ChatGPTCreate a new webhook endpoint with a URL and list of event types to subscribe to.
create_webhook_endpoint
ChatGPTCreate a new webhook endpoint with a URL and list of event types to subscribe to.
delete_coupon
ChatGPTPermanently delete a coupon by ID. This cannot be undone.
delete_coupon
ChatGPTPermanently delete a coupon by ID. This cannot be undone.
delete_custom_property
ChatGPTDelete an existing custom property definition by ID. This removes the property from all entities.
delete_custom_property
ChatGPTDelete an existing custom property definition by ID. This removes the property from all entities.
delete_customer
ChatGPTPermanently delete a customer by ID. The customer must be archived first. This cannot be undone.
delete_customer
ChatGPTPermanently delete a customer by ID. The customer must be archived first. This cannot be undone.
delete_customer_payment_method
ChatGPTRemove a payment method from a customer. The payment method is deleted permanently.
delete_customer_payment_method
ChatGPTRemove a payment method from a customer. The payment method is deleted permanently.
delete_file
ChatGPTPermanently delete a file by ID.
delete_file
ChatGPTPermanently delete a file by ID.
delete_invoice
ChatGPTDelete a draft or externally-imported invoice. For finalized invoices, use void_invoice instead.
delete_invoice
ChatGPTDelete a draft or externally-imported invoice. For finalized invoices, use void_invoice instead.
delete_invoice_transaction
ChatGPTDelete a scheduled transaction from an invoice. Only applies to transactions that haven't been processed yet.
delete_invoice_transaction
ChatGPTDelete a scheduled transaction from an invoice. Only applies to transactions that haven't been processed yet.
delete_invoicing_entity
ChatGPTSoft-delete an invoicing entity by ID. Existing invoices linked to it are preserved.
delete_invoicing_entity
ChatGPTSoft-delete an invoicing entity by ID. Existing invoices linked to it are preserved.
delete_price_configuration
ChatGPTDelete a price configuration by ID. This removes the pricing option from the product.
delete_price_configuration
ChatGPTDelete a price configuration by ID. This removes the pricing option from the product.
delete_promotion_code
ChatGPTPermanently delete a promotion code by ID. This cannot be undone.
delete_promotion_code
ChatGPTPermanently delete a promotion code by ID. This cannot be undone.
delete_webhook_endpoint
ChatGPTDelete a webhook endpoint. No further events will be delivered to it.
delete_webhook_endpoint
ChatGPTDelete a webhook endpoint. No further events will be delivered to it.
download_export
ChatGPTDownload the file for a completed export. Supports CSV, JSON, and XLSX formats depending on the export type.
download_export
ChatGPTDownload the file for a completed export. Supports CSV, JSON, and XLSX formats depending on the export type.
download_file
ChatGPTDownload the raw content of a file by ID. Returns the file binary with appropriate content type.
download_file
ChatGPTDownload the raw content of a file by ID. Returns the file binary with appropriate content type.
download_invoice
ChatGPTDownload the PDF of an invoice. For draft/open invoices, generates the PDF on the fly. Supports lang/locale params for localization.
download_invoice
ChatGPTDownload the PDF of an invoice. For draft/open invoices, generates the PDF on the fly. Supports lang/locale params for localization.
download_quote
ChatGPTDownload the PDF of a quote. Supports locale parameter for localization.
download_quote
ChatGPTDownload the PDF of a quote. Supports locale parameter for localization.
download_quote_file
ChatGPTDownload an attachment or manually signed PDF file from a quote.
download_quote_file
ChatGPTDownload an attachment or manually signed PDF file from a quote.
get_analytics
ChatGPTRetrieve pre-computed account analytics including ARR, MRR, revenues, churn rate, and other key billing metrics. Optionally filter by invoicing_entity_id. Use this to get a high-level financial overview.
get_analytics
ChatGPTRetrieve pre-computed account analytics including ARR, MRR, revenues, churn rate, and other key billing metrics. Optionally filter by invoicing_entity_id. Use this to get a high-level financial overview.
get_bank_account
ChatGPTRetrieve a specific bank account by its ID. Returns bank account details including IBAN, BIC, and currency.
get_bank_account
ChatGPTRetrieve a specific bank account by its ID. Returns bank account details including IBAN, BIC, and currency.
get_coupon
ChatGPTRetrieve a specific coupon by ID including its discount configuration, redemption count, and deletion status.
get_coupon
ChatGPTRetrieve a specific coupon by ID including its discount configuration, redemption count, and deletion status.
get_customer
ChatGPTRetrieve full details of a customer by ID including billing info, address, subscriptions, custom properties, integrations, payment method, and bank account.
get_customer
ChatGPTRetrieve full details of a customer by ID including billing info, address, subscriptions, custom properties, integrations, payment method, and bank account.
get_customer_credit
ChatGPTRetrieve details of a specific credit product for a customer, including current balance, configuration, and product info.
get_customer_credit
ChatGPTRetrieve details of a specific credit product for a customer, including current balance, configuration, and product info.
get_customer_payment_method
ChatGPTRetrieve details of a specific payment method by ID including type, last4, expiry, and default status.
get_customer_payment_method
ChatGPTRetrieve details of a specific payment method by ID including type, last4, expiry, and default status.
get_customer_portal_url
ChatGPTGet a portal URL for a customer. The portal allows the customer to view invoices, update payment methods, and manage their account.
get_customer_portal_url
ChatGPTGet a portal URL for a customer. The portal allows the customer to view invoices, update payment methods, and manage their account.
get_customer_tax_rates
ChatGPTRetrieve the eligible tax rates for a specific customer based on their location and tax configuration.
get_customer_tax_rates
ChatGPTRetrieve the eligible tax rates for a specific customer based on their location and tax configuration.
get_customer_valuation
ChatGPTCompute aggregated valuation metrics for a customer across all active subscriptions, grouped by currency. Returns contract value, recurring contract value, and ARR for each subscription and aggregated totals. Optionally pass granularity (year/quarter/month) for period breakdown.
get_customer_valuation
ChatGPTCompute aggregated valuation metrics for a customer across all active subscriptions, grouped by currency. Returns contract value, recurring contract value, and ARR for each subscription and aggregated totals. Optionally pass granularity (year/quarter/month) for period breakdown.
get_export
ChatGPTCheck the status of an export by ID. Status can be pending, processing, or completed. Use download_export to get the file once completed.
get_export
ChatGPTCheck the status of an export by ID. Status can be pending, processing, or completed. Use download_export to get the file once completed.
get_invoice
ChatGPTRetrieve the details of an invoice by ID including line items, transactions, customer info, and billing metadata.
get_invoice
ChatGPTRetrieve the details of an invoice by ID including line items, transactions, customer info, and billing metadata.
get_invoicing_entity
ChatGPTRetrieve a specific invoicing entity by ID with its full configuration (address, tax ID, branding, payment settings).
get_invoicing_entity
ChatGPTRetrieve a specific invoicing entity by ID with its full configuration (address, tax ID, branding, payment settings).
get_organisation
ChatGPTRetrieve details of an organisation by ID. Organisations group customers and can have their own billing configuration.
get_organisation
ChatGPTRetrieve details of an organisation by ID. Organisations group customers and can have their own billing configuration.
get_product
ChatGPTRetrieve full details of a product by ID including up to 50 price configurations. Use list_price_configurations for the complete list. Optionally filter by price_book_id.
get_product
ChatGPTRetrieve full details of a product by ID including up to 50 price configurations. Use list_price_configurations for the complete list. Optionally filter by price_book_id.
get_promotion_code
ChatGPTRetrieve a specific promotion code by ID with its linked coupon details.
get_promotion_code
ChatGPTRetrieve a specific promotion code by ID with its linked coupon details.
get_quote
ChatGPTRetrieve full details of a quote by ID including line items, status, signature info, and linked subscription.
get_quote
ChatGPTRetrieve full details of a quote by ID including line items, status, signature info, and linked subscription.
get_quote_valuation
ChatGPTCompute valuation metrics for a quote: contract value (total/invoiced/remaining), recurring contract value, and ARR (fixed + variable). Optionally pass granularity (year/quarter/month) for period breakdown. Returns 404 if the quote has no subscription or is not a subscription-type quote.
get_quote_valuation
ChatGPTCompute valuation metrics for a quote: contract value (total/invoiced/remaining), recurring contract value, and ARR (fixed + variable). Optionally pass granularity (year/quarter/month) for period breakdown. Returns 404 if the quote has no subscription or is not a subscription-type quote.
get_subscription
ChatGPTRetrieve full details of a subscription by ID including phases, products, billing dates, and status. Optionally include live_billing data.
get_subscription
ChatGPTRetrieve full details of a subscription by ID including phases, products, billing dates, and status. Optionally include live_billing data.
get_subscription_phase
ChatGPTRetrieve details of a specific phase within a subscription, including its products and billing configuration.
get_subscription_phase
ChatGPTRetrieve details of a specific phase within a subscription, including its products and billing configuration.
get_subscription_template
ChatGPTRetrieve a subscription template by ID with its full configuration including products, phases, and pricing details.
get_subscription_template
ChatGPTRetrieve a subscription template by ID with its full configuration including products, phases, and pricing details.
get_subscription_transition
ChatGPTRetrieve details of a subscription transition by ID including source/target subscriptions and schedule.
get_subscription_transition
ChatGPTRetrieve details of a subscription transition by ID including source/target subscriptions and schedule.
get_subscription_valuation
ChatGPTCompute valuation metrics for a subscription: contract value (total/invoiced/remaining), recurring contract value, and ARR (fixed + variable). Optionally pass granularity (year/quarter/month) for period breakdown.
get_subscription_valuation
ChatGPTCompute valuation metrics for a subscription: contract value (total/invoiced/remaining), recurring contract value, and ARR (fixed + variable). Optionally pass granularity (year/quarter/month) for period breakdown.
get_tax_rate
ChatGPTRetrieve details of a custom tax rate by ID including rate percentage, applicable countries, and linked invoicing entity.
get_tax_rate
ChatGPTRetrieve details of a custom tax rate by ID including rate percentage, applicable countries, and linked invoicing entity.
get_wallet
ChatGPTRetrieve details of a wallet by ID including current balance, currency, and linked customer.
get_wallet
ChatGPTRetrieve details of a wallet by ID including current balance, currency, and linked customer.
get_wallet_settings
ChatGPTRetrieve global wallet settings for the account (e.g. default currency, auto-topup configuration).
get_wallet_settings
ChatGPTRetrieve global wallet settings for the account (e.g. default currency, auto-topup configuration).
get_webhook_endpoint
ChatGPTRetrieve details of a webhook endpoint by ID including URL, subscribed events, and status.
get_webhook_endpoint
ChatGPTRetrieve details of a webhook endpoint by ID including URL, subscribed events, and status.
list_bank_accounts
ChatGPTList all bank accounts configured on the account. Returns paginated results with take/skip.
list_bank_accounts
ChatGPTList all bank accounts configured on the account. Returns paginated results with take/skip.
list_companies
ChatGPTList all companies accessible to the current authentication token. A company represents an organizational unit.
list_companies
ChatGPTList all companies accessible to the current authentication token. A company represents an organizational unit.
list_coupons
ChatGPTList all coupons with pagination (take/skip). Coupons define discount rules (percentage or fixed amount) that can be applied to subscriptions or invoices.
list_coupons
ChatGPTList all coupons with pagination (take/skip). Coupons define discount rules (percentage or fixed amount) that can be applied to subscriptions or invoices.
list_custom_properties
ChatGPTList all custom properties defined on the account. Custom properties are user-defined fields that can be attached to customers, subscriptions, and other entities.
list_custom_properties
ChatGPTList all custom properties defined on the account. Custom properties are user-defined fields that can be attached to customers, subscriptions, and other entities.
list_customer_credit_transactions
ChatGPTList all transactions (purchases, topups, usages) for a specific credit product. Paginated with take/skip and optional filters.
list_customer_credit_transactions
ChatGPTList all transactions (purchases, topups, usages) for a specific credit product. Paginated with take/skip and optional filters.
list_customer_credits
ChatGPTList credit products attached to a specific customer. Paginated with take/skip.
list_customer_credits
ChatGPTList credit products attached to a specific customer. Paginated with take/skip.
list_customer_payment_methods
ChatGPTList all payment methods attached to a specific customer (cards, SEPA mandates, etc.).
list_customer_payment_methods
ChatGPTList all payment methods attached to a specific customer (cards, SEPA mandates, etc.).
list_customers
ChatGPTList customers with optional filters for name, type, status, currency, country, external_id, billing_email, search, tax_id, subscription_status, invoicing_entity_id, segment_id, custom_properties, payment_method_type, integration_entity_id, created_at, and updated_at. Sortable by created_at or updated_at. Paginated with limit/cursor.
list_customers
ChatGPTList customers with optional filters for name, type, status, currency, country, external_id, billing_email, search, tax_id, subscription_status, invoicing_entity_id, segment_id, custom_properties, payment_method_type, integration_entity_id, created_at, and updated_at. Sortable by created_at or updated_at. Paginated with limit/cursor.
list_customers_credits
ChatGPTList credit products across all customers with optional filters for product_id, customer_id, and updated_at. Paginated with take/skip.
list_customers_credits
ChatGPTList credit products across all customers with optional filters for product_id, customer_id, and updated_at. Paginated with take/skip.
list_customers_segments
ChatGPTRetrieve all customer segments.
list_customers_segments
ChatGPTRetrieve all customer segments.
list_exports
ChatGPTList the client's data exports (customers, invoices, etc.) with pagination. Use take/skip to page through results.
list_exports
ChatGPTList the client's data exports (customers, invoices, etc.) with pagination. Use take/skip to page through results.
list_files
ChatGPTList uploaded files with optional filters for name and customer_id. Paginated with take/skip.
list_files
ChatGPTList uploaded files with optional filters for name and customer_id. Paginated with take/skip.
list_invoices
ChatGPTList invoices with filters for type, status, customer_id, customer_external_id, subscription_id, invoicing_entity_id, invoice_number, period dates, emission_date, due_date, and updated_at. Sortable by created_at or emitted_at. By default, open invoices are excluded. Paginated with limit/cursor.
list_invoices
ChatGPTList invoices with filters for type, status, customer_id, customer_external_id, subscription_id, invoicing_entity_id, invoice_number, period dates, emission_date, due_date, and updated_at. Sortable by created_at or emitted_at. By default, open invoices are excluded. Paginated with limit/cursor.
list_invoicing_entities
ChatGPTList all invoicing entities (legal entities that issue invoices). Each has its own address, tax ID, and branding. Paginated with take/skip.
list_invoicing_entities
ChatGPTList all invoicing entities (legal entities that issue invoices). Each has its own address, tax ID, and branding. Paginated with take/skip.
list_price_configurations
ChatGPTList price configurations with optional filters for product_id and price_book_id. Price configurations define how a product is priced (tiers, volume, graduated, etc.). Paginated with take/skip.
list_price_configurations
ChatGPTList price configurations with optional filters for product_id and price_book_id. Price configurations define how a product is priced (tiers, volume, graduated, etc.). Paginated with take/skip.
list_products
ChatGPTList products with optional filters for id, status, name, description, type, and price_book_id. Products define what is being sold (flat fee, per-unit, usage-based, etc.). Paginated with take/skip.
list_products
ChatGPTList products with optional filters for id, status, name, description, type, and price_book_id. Products define what is being sold (flat fee, per-unit, usage-based, etc.). Paginated with take/skip.
list_promotion_codes
ChatGPTList promotion codes with optional filter by coupon_id. Promotion codes are shareable codes that reference a coupon. Paginated with take/skip.
list_promotion_codes
ChatGPTList promotion codes with optional filter by coupon_id. Promotion codes are shareable codes that reference a coupon. Paginated with take/skip.
list_quotes
ChatGPTList quotes with optional filters for id, number, status, customer_id, template_id, crm_opportunity_id, type, and updated_at. Paginated with take/skip.
list_quotes
ChatGPTList quotes with optional filters for id, number, status, customer_id, template_id, crm_opportunity_id, type, and updated_at. Paginated with take/skip.
list_subscription_phases
ChatGPTList all phases of a subscription. Phases define time-bound product configurations within a subscription.
list_subscription_phases
ChatGPTList all phases of a subscription. Phases define time-bound product configurations within a subscription.
list_subscription_templates
ChatGPTList subscription templates with pagination. Templates define reusable subscription configurations with pre-configured products, phases, and billing settings.
list_subscription_templates
ChatGPTList subscription templates with pagination. Templates define reusable subscription configurations with pre-configured products, phases, and billing settings.
list_subscription_transitions
ChatGPTList subscription transitions (migrations from one subscription to another). Filterable and paginated with take/skip.
list_subscription_transitions
ChatGPTList subscription transitions (migrations from one subscription to another). Filterable and paginated with take/skip.
list_subscriptions
ChatGPTList subscriptions with filters for activation_strategy, status, currency, plan_id, original_quote_id, integration_entity_id, customer_id, invoicing_entity_id, purchase_order, updated_at, custom_properties. Draft, voided, and cancelled excluded by default. Paginated with take/skip.
list_subscriptions
ChatGPTList subscriptions with filters for activation_strategy, status, currency, plan_id, original_quote_id, integration_entity_id, customer_id, invoicing_entity_id, purchase_order, updated_at, custom_properties. Draft, voided, and cancelled excluded by default. Paginated with take/skip.
list_tax_rates
ChatGPTList custom tax rates with optional filters for id, name, description, and invoicing_entity_id. Paginated with take/skip.
list_tax_rates
ChatGPTList custom tax rates with optional filters for id, name, description, and invoicing_entity_id. Paginated with take/skip.
list_wallet_transactions
ChatGPTList all transactions (loads, usages, refunds) for a wallet. Paginated with take/skip.
list_wallet_transactions
ChatGPTList all transactions (loads, usages, refunds) for a wallet. Paginated with take/skip.
list_wallets
ChatGPTList wallets with optional customer_id filter. Wallets hold prepaid credit balances that are drawn down during invoicing. Paginated with take/skip.
list_wallets
ChatGPTList wallets with optional customer_id filter. Wallets hold prepaid credit balances that are drawn down during invoicing. Paginated with take/skip.
list_webhook_endpoints
ChatGPTList all webhook endpoints configured on the account. Endpoints receive event notifications via HTTP POST.
list_webhook_endpoints
ChatGPTList all webhook endpoints configured on the account. Endpoints receive event notifications via HTTP POST.
list_webhook_messages
ChatGPTList webhook messages sent across all endpoints. Filterable by event_types, before/after dates. Payloads are expunged after 90 days. Uses cursor-based pagination.
list_webhook_messages
ChatGPTList webhook messages sent across all endpoints. Filterable by event_types, before/after dates. Payloads are expunged after 90 days. Uses cursor-based pagination.
load_wallet
ChatGPTAdd credits to a wallet by charging the customer's payment method. The customer must have an active payment method.
load_wallet
ChatGPTAdd credits to a wallet by charging the customer's payment method. The customer must have an active payment method.
mark_invoice_as_uncollectible
ChatGPTMark an invoice as uncollectible for accounting write-off purposes. The invoice remains in the system for record keeping.
mark_invoice_as_uncollectible
ChatGPTMark an invoice as uncollectible for accounting write-off purposes. The invoice remains in the system for record keeping.
patch_organisation
ChatGPTUpdate an existing organisation's details by ID.
patch_organisation
ChatGPTUpdate an existing organisation's details by ID.
pause_subscription
ChatGPTPause a subscription. Billing stops while paused. Optionally specify a reactivate_at date for automatic resumption.
pause_subscription
ChatGPTPause a subscription. Billing stops while paused. Optionally specify a reactivate_at date for automatic resumption.
ping
ChatGPTCheck if the hyperline MCP server is running
ping
ChatGPTCheck if the hyperline MCP server is running
purchase_customer_credits
ChatGPTPurchase credits for a customer. This generates an invoice and charges the customer. Returns the invoice ID and new balance.
purchase_customer_credits
ChatGPTPurchase credits for a customer. This generates an invoice and charges the customer. Returns the invoice ID and new balance.
reactivate_subscription
ChatGPTResume a paused subscription, restarting billing from the current date.
reactivate_subscription
ChatGPTResume a paused subscription, restarting billing from the current date.
refresh_subscription_seat_products
ChatGPTTrigger a count update on seat-based products within a subscription using the configured dataloader query.
refresh_subscription_seat_products
ChatGPTTrigger a count update on seat-based products within a subscription using the configured dataloader query.
refund_transaction
ChatGPTRefund a settled banking transaction for its full amount. The related invoice will switch back to to pay status. Use the create credit note endpoint if you want to cancel (and optionally refund) the initial invoice.
refund_transaction
ChatGPTRefund a settled banking transaction for its full amount. The related invoice will switch back to to pay status. Use the create credit note endpoint if you want to cancel (and optionally refund) the initial invoice.
reinstate_subscription
ChatGPTReinstate a subscription that is scheduled for cancellation, reverting it to active status.
reinstate_subscription
ChatGPTReinstate a subscription that is scheduled for cancellation, reverting it to active status.
renew_subscription
ChatGPTFast-forward a subscription to a specific date, generating all intermediate invoices. Useful for pre-billing. Activates pending subscriptions. Max 36 renewals.
renew_subscription
ChatGPTFast-forward a subscription to a specific date, generating all intermediate invoices. Useful for pre-billing. Activates pending subscriptions. Max 36 renewals.
revert_wallet_load
ChatGPTRevert a wallet credit transaction: voids the related credit note and creates a debit transaction to undo the load.
revert_wallet_load
ChatGPTRevert a wallet credit transaction: voids the related credit note and creates a debit transaction to undo the load.
send_quote
ChatGPTSend a quote by email for customer signature. Requires the quote to be approved first.
send_quote
ChatGPTSend a quote by email for customer signature. Requires the quote to be approved first.
sign_quote
ChatGPTManually mark a quote as signed externally. Optionally upload a signed PDF. Bypasses the built-in Hyperline signature flow.
sign_quote
ChatGPTManually mark a quote as signed externally. Optionally upload a signed PDF. Bypasses the built-in Hyperline signature flow.
simulate_subscription_updates
ChatGPTPreview the effect of updates on a subscription without applying them. Returns simulated invoice and billing impact.
simulate_subscription_updates
ChatGPTPreview the effect of updates on a subscription without applying them. Returns simulated invoice and billing impact.
topup_customer_credits
ChatGPTAdd free credits to a customer's balance. Unlike purchase, this does not generate an invoice or charge the customer.
topup_customer_credits
ChatGPTAdd free credits to a customer's balance. Unlike purchase, this does not generate an invoice or charge the customer.
transition_subscription
ChatGPTTransition a subscription to its next configured phase at a specified date.
transition_subscription
ChatGPTTransition a subscription to its next configured phase at a specified date.
unarchive_customer
ChatGPTRestore a previously archived customer by ID, making it visible again in default list views.
unarchive_customer
ChatGPTRestore a previously archived customer by ID, making it visible again in default list views.
unarchive_product
ChatGPTRestore a previously archived product, making it available for new subscriptions again.
unarchive_product
ChatGPTRestore a previously archived product, making it available for new subscriptions again.
update_coupon
ChatGPTUpdate an existing coupon's name, discount rules, or restrictions.
update_coupon
ChatGPTUpdate an existing coupon's name, discount rules, or restrictions.
update_custom_property
ChatGPTUpdate an existing custom property definition by ID.
update_custom_property
ChatGPTUpdate an existing custom property definition by ID.
update_customer
ChatGPTUpdate a customer's details including name, billing email, address, currency, tax ID, and custom properties.
update_customer
ChatGPTUpdate a customer's details including name, billing email, address, currency, tax ID, and custom properties.
update_customer_credit
ChatGPTUpdate the configuration of a customer's credit product (e.g. balance thresholds, auto-topup settings).
update_customer_credit
ChatGPTUpdate the configuration of a customer's credit product (e.g. balance thresholds, auto-topup settings).
update_customers_segment
ChatGPTUpdate an existing customer segment.
update_customers_segment
ChatGPTUpdate an existing customer segment.
update_invoice
ChatGPTUpdate a draft or grace_period invoice. Allows modifying line items, dates, and metadata before finalization.
update_invoice
ChatGPTUpdate a draft or grace_period invoice. Allows modifying line items, dates, and metadata before finalization.
update_invoicing_entity
ChatGPTUpdate an existing invoicing entity's details (address, tax ID, branding, etc.).
update_invoicing_entity
ChatGPTUpdate an existing invoicing entity's details (address, tax ID, branding, etc.).
update_prices
ChatGPTUpdate the prices of an existing price configuration by ID. Allows changing tier thresholds, unit prices, and flat fees.
update_prices
ChatGPTUpdate the prices of an existing price configuration by ID. Allows changing tier thresholds, unit prices, and flat fees.
update_product
ChatGPTUpdate a product's name, description, type, or configuration by ID.
update_product
ChatGPTUpdate a product's name, description, type, or configuration by ID.
update_promotion_code
ChatGPTUpdate an existing promotion code's configuration (excluding the linked coupon).
update_promotion_code
ChatGPTUpdate an existing promotion code's configuration (excluding the linked coupon).
update_quote
ChatGPTUpdate quote-level fields before a quote is finalized. On draft quotes, pass subscription to create or replace the draft subscription configuration, or pass invoice on a one-off quote to replace the linked draft invoice.
update_quote
ChatGPTUpdate quote-level fields before a quote is finalized. On draft quotes, pass subscription to create or replace the draft subscription configuration, or pass invoice on a one-off quote to replace the linked draft invoice.
update_subscription
ChatGPTComprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons. Draft quote subscription configuration must be updated through PATCH /v1/quotes/{id}.
update_subscription
ChatGPTComprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons. Draft quote subscription configuration must be updated through PATCH /v1/quotes/{id}.
update_wallet
ChatGPTUpdate a wallet's configuration (e.g. name, auto-topup settings).
update_wallet
ChatGPTUpdate a wallet's configuration (e.g. name, auto-topup settings).
update_wallet_settings
ChatGPTUpdate global wallet settings for the account.
update_wallet_settings
ChatGPTUpdate global wallet settings for the account.
update_webhook_endpoint
ChatGPTUpdate a webhook endpoint's URL, subscribed events, or enabled status.
update_webhook_endpoint
ChatGPTUpdate a webhook endpoint's URL, subscribed events, or enabled status.
upload_pdf_to_invoice
ChatGPTUpload a custom PDF file (max 5MB) to attach to an existing invoice, replacing the auto-generated PDF.
upload_pdf_to_invoice
ChatGPTUpload a custom PDF file (max 5MB) to attach to an existing invoice, replacing the auto-generated PDF.
validate_invoice
ChatGPTFinalize a draft invoice: sets its status to to_pay, assigns an invoice number, and makes it immutable. This action is irreversible.
validate_invoice
ChatGPTFinalize a draft invoice: sets its status to to_pay, assigns an invoice number, and makes it immutable. This action is irreversible.
void_invoice
ChatGPTVoid an invoice in to_pay status. Automatically generates a corresponding credit note. Optionally send an email notification.
void_invoice
ChatGPTVoid an invoice in to_pay status. Automatically generates a corresponding credit note. Optionally send an email notification.
void_quote
ChatGPTVoid an existing quote, canceling it and preventing further actions.
void_quote
ChatGPTVoid an existing quote, canceling it and preventing further actions.