Hyperline

Create 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

Create a credit entity for a customer linked to a specific product with an optional initial balance.

create_customer_credit

Record credit usage for a customer's credit product. Deducts the specified usage_retained amount from the balance.

create_customer_credits_usage

Create a new custom property definition with a name, type (string, number, boolean, date, select), and optional default value.

create_custom_property

Create a new customer with billing details, address, currency, and optional provider mappings. Returns the full customer object.

create_customer

Create up to 50 customers in a single batch request. Returns successes and errors separately for each customer in the batch.

create_customers

Prepare a data export (customers, invoices, etc.) for download. Check export status via get_export, then download via download_export once ready.

create_export

Upload a new file (max 10MB). Requires multipart form data with a file field and metadata (name, optional customer_id).

create_file

Create a new invoice for a customer with line items, due date, and billing configuration. Returns the full invoice object.

create_invoice

Create multiple invoices asynchronously in batch. Track results via webhooks (invoice.batch.creation_succeeded / invoice.batch.creation_failed). Returns a batch_id.

create_invoices

Create a new invoicing entity with company details, address, and tax configuration. Used as the sender on invoices.

create_invoicing_entity

Initiate 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

Import an existing payment method from a connected payment provider (e.g. Stripe) for a customer.

create_customer_payment_method

Create a new product with name, type (flat_fee, per_unit, usage, seat, etc.), and pricing configuration.

create_product

Create a new promotion code linked to an existing coupon. The code can be shared with customers for self-service discount application.

create_promotion_code

Create 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

Create a new customer segment.

create_customers_segment

Create 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

Create a transition from one subscription to another, configured from a subscription, plan, or template. Can be applied immediately or scheduled.

create_subscription_transition

Apply a single update to an existing subscription (e.g. change quantity, add/remove product, modify price).

create_subscription_update

Apply multiple updates at once to an existing subscription in a single atomic operation.

create_subscription_updates

Record a payment transaction on an invoice. May update the invoice status to paid or partially_paid depending on the amount.

create_invoice_transaction

Create a new prepaid wallet for a customer with an initial balance and currency.

create_wallet

Create a new webhook endpoint with a URL and list of event types to subscribe to.

create_webhook_endpoint

Permanently delete a coupon by ID. This cannot be undone.

delete_coupon

Delete an existing custom property definition by ID. This removes the property from all entities.

delete_custom_property

Permanently delete a customer by ID. The customer must be archived first. This cannot be undone.

delete_customer

Permanently delete a file by ID.

delete_file

Delete a draft or externally-imported invoice. For finalized invoices, use void_invoice instead.

delete_invoice

Soft-delete an invoicing entity by ID. Existing invoices linked to it are preserved.

delete_invoicing_entity

Remove a payment method from a customer. The payment method is deleted permanently.

delete_customer_payment_method

Delete a price configuration by ID. This removes the pricing option from the product.

delete_price_configuration

Permanently delete a promotion code by ID. This cannot be undone.

delete_promotion_code

Delete a scheduled transaction from an invoice. Only applies to transactions that haven't been processed yet.

delete_invoice_transaction

Delete a webhook endpoint. No further events will be delivered to it.

delete_webhook_endpoint

Download the file for a completed export. Supports CSV, JSON, and XLSX formats depending on the export type.

download_export

Download the raw content of a file by ID. Returns the file binary with appropriate content type.

download_file

Download the PDF of an invoice. For draft/open invoices, generates the PDF on the fly. Supports lang/locale params for localization.

download_invoice

Download the PDF of a quote. Supports locale parameter for localization.

download_quote

Download an attachment or manually signed PDF file from a quote.

download_quote_file