Hyperline

# Hyperline

## Docs

- [Currency amounts](https://docs.hyperline.co/api-reference/docs/amount.md): Technical representation of monetary values in Hyperline
- [Authentication](https://docs.hyperline.co/api-reference/docs/authentication.md): Learn how to authenticate to use Hyperline's API
- [Dates & timezones](https://docs.hyperline.co/api-reference/docs/dates-and-timezones.md): Technical representation of dates in Hyperline
- [Error handling](https://docs.hyperline.co/api-reference/docs/error-handling.md): Learn how to handle errors when using Hyperline's API
- [Getting started](https://docs.hyperline.co/api-reference/docs/getting-started.md): Welcome to the Hyperline technical documentation
- [Pagination and filtering](https://docs.hyperline.co/api-reference/docs/pagination.md)
- [Rate limiting](https://docs.hyperline.co/api-reference/docs/rate-limiting.md)
- [React components](https://docs.hyperline.co/api-reference/docs/react-components.md): Learn how to embed Hyperline directly into your React application
- [Third-party app](https://docs.hyperline.co/api-reference/docs/third-party-app.md): Enable your app to access Hyperline accounts using OAuth flows
- [API upgrades](https://docs.hyperline.co/api-reference/docs/upgrades.md): Keep track of changes and deprecation to the Hyperline API
- [Webhooks](https://docs.hyperline.co/api-reference/docs/webhooks.md): Receive webhook messages
- [Get analytics](https://docs.hyperline.co/api-reference/endpoints/analytics/get-analytics.md): Retrieve your pre-computed account's analytics (ARR, revenues, churn, etc).
- [Get bank account](https://docs.hyperline.co/api-reference/endpoints/bank-accounts/get-bank-account.md): Retrieve a specific bank account by ID.
- [Get bank accounts](https://docs.hyperline.co/api-reference/endpoints/bank-accounts/get-bank-accounts.md): Retrieve all bank accounts.
- [Create billable event](https://docs.hyperline.co/api-reference/endpoints/billable-events/create-billable-event.md): Create a new billable event.
- [Create billable events](https://docs.hyperline.co/api-reference/endpoints/billable-events/create-billable-events.md): Create several billable events in batch (limited to max 5000 events per request).
- [Delete billable events](https://docs.hyperline.co/api-reference/endpoints/billable-events/delete-billable-events.md): Delete existing billable events.
- [Get billable event prices](https://docs.hyperline.co/api-reference/endpoints/billable-events/get-billable-event-prices.md): Get previous calculation results for a billable event. You can search by either calculation_id / record_id or both.
- [Ingest and calculate billable event prices](https://docs.hyperline.co/api-reference/endpoints/billable-events/ingest-and-calculate-billable-event-prices.md): Ingest and calculate prices for a single billable event. After the first ingestion, events are not ingested again and the prices won't be calculated again. The initially calculated prices will be returned in subsequent calls.
- [Simulate billable event prices](https://docs.hyperline.co/api-reference/endpoints/billable-events/simulate-billable-event-prices.md): Simulate prices for a single billable event without ingesting it.
- [Create company](https://docs.hyperline.co/api-reference/endpoints/companies/create-company.md): Create a new company to which the authentication token will have access to.
- [Get companies](https://docs.hyperline.co/api-reference/endpoints/companies/get-companies.md): Retrieve all companies that the authentication token has access to.
- [Create promotion code](https://docs.hyperline.co/api-reference/endpoints/coupons->-promotion-codes/create-promotion-code.md): Create a new promotion code.
- [Delete promotion code](https://docs.hyperline.co/api-reference/endpoints/coupons->-promotion-codes/delete-promotion-code.md): Delete an existing promotion code.
- [Get promotion code](https://docs.hyperline.co/api-reference/endpoints/coupons->-promotion-codes/get-promotion-code.md): Retrieve the details of an existing promotion code.
- [Get promotion codes](https://docs.hyperline.co/api-reference/endpoints/coupons->-promotion-codes/get-promotion-codes.md): Retrieve all existing promotion codes.
- [Update promotion code](https://docs.hyperline.co/api-reference/endpoints/coupons->-promotion-codes/update-promotion-code.md): Update the details of an existing promotion code.
- [Create coupon](https://docs.hyperline.co/api-reference/endpoints/coupons/create-coupon.md): Create a new coupon.
- [Delete coupon](https://docs.hyperline.co/api-reference/endpoints/coupons/delete-coupon.md): Delete an existing coupon.
- [Get coupon](https://docs.hyperline.co/api-reference/endpoints/coupons/get-coupon.md): Retrieve the details of an existing coupon.
- [Get coupons](https://docs.hyperline.co/api-reference/endpoints/coupons/get-coupons.md): Retrieve all existing coupons.
- [Update coupon](https://docs.hyperline.co/api-reference/endpoints/coupons/update-coupon.md): Update the details of an existing coupon.
- [Create custom property](https://docs.hyperline.co/api-reference/endpoints/custom-properties/create-custom-property.md): Create a new custom property.
- [Delete custom property](https://docs.hyperline.co/api-reference/endpoints/custom-properties/delete-custom-property.md): Delete an existing custom property.
- [Get custom properties](https://docs.hyperline.co/api-reference/endpoints/custom-properties/get-custom-properties.md): Retrieve all custom properties previously created.
- [Update custom property](https://docs.hyperline.co/api-reference/endpoints/custom-properties/update-custom-property.md): Update an existing custom property.
- [Create credit product](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/create-credit-product.md): Create a credit entity for a given product with an optional balance.
- [Create credits usage](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/create-credits-usage.md): Create a usage entry for a credit product. This will impact the balance of the customer by `usage_retained`.
- [Get all credit products](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/get-all-credit-products.md): List all credit products for all customers.
- [Get credit product](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/get-credit-product.md): Retrieve the details of an existing credit product for a customer.
- [Get credit products](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/get-credit-products.md): List all credit products attached to a customer.
- [Get credit transactions](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/get-credit-transactions.md): Retrieve all credit transactions associated with a credit product.
- [Purchase credits](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/purchase-credits.md): Purchase a number of credits. This action will generate an invoice and charge the customer.
- [Topup credits](https://docs.hyperline.co/api-reference/endpoints/customers->-credits/topup-credits.md): Topup a number of free credits. This action will not charge the customer.
- [Create payment method](https://docs.hyperline.co/api-reference/endpoints/customers->-payment-methods/create-payment-method.md): Import an existing customer payment method from a connected payment provider.
- [Delete payment method](https://docs.hyperline.co/api-reference/endpoints/customers->-payment-methods/delete-payment-method.md): Delete an existing customer payment method.
- [Get payment method](https://docs.hyperline.co/api-reference/endpoints/customers->-payment-methods/get-payment-method.md): Retrieve the details of an existing customer payment method.
- [Get payment methods](https://docs.hyperline.co/api-reference/endpoints/customers->-payment-methods/get-payment-methods.md): List all payment methods attached to a customer.
- [Archive customer](https://docs.hyperline.co/api-reference/endpoints/customers/archive-customer.md): Archive an existing customer.
- [Bulk update providers/customers mapping](https://docs.hyperline.co/api-reference/endpoints/customers/bulk-update-providerscustomers-mapping.md): Bulk update providers/customers mapping, make sure to check the query response to see if all customers were updated.
- [Create customer](https://docs.hyperline.co/api-reference/endpoints/customers/create-customer.md): Create a new customer.
- [Delete customer](https://docs.hyperline.co/api-reference/endpoints/customers/delete-customer.md): Delete an existing customer. The customer must be archived prior to the deletion.
- [Get customer](https://docs.hyperline.co/api-reference/endpoints/customers/get-customer.md): Retrieve the details of an existing customer.
- [Get customer portal](https://docs.hyperline.co/api-reference/endpoints/customers/get-customer-portal.md): Retrieve the URL of the customer portal.
- [Get customer tax rates](https://docs.hyperline.co/api-reference/endpoints/customers/get-customer-tax-rates.md): Retrieve the eligible tax rates for a customer.
- [Get customers](https://docs.hyperline.co/api-reference/endpoints/customers/get-customers.md): Retrieve all existing customers.
- [Unarchive customer](https://docs.hyperline.co/api-reference/endpoints/customers/unarchive-customer.md): Unarchive an archived customer.
- [Update customer](https://docs.hyperline.co/api-reference/endpoints/customers/update-customer.md): Update the details of an existing customer.
- [Create file](https://docs.hyperline.co/api-reference/endpoints/files/create-file.md): Create a new file.
- [Delete file](https://docs.hyperline.co/api-reference/endpoints/files/delete-file.md): Delete an existing file.
- [Download file](https://docs.hyperline.co/api-reference/endpoints/files/download-file.md): Download an existing file content.
- [Get files](https://docs.hyperline.co/api-reference/endpoints/files/get-files.md): Retrieve all existing files.
- [Create component token](https://docs.hyperline.co/api-reference/endpoints/integrations/create-component-token.md): Create a new token for embedded components.
- [Create transaction](https://docs.hyperline.co/api-reference/endpoints/invoices->-transactions/create-transaction.md): Create a transaction linked to an existing invoice. This may update the invoice status to paid/partially paid.
- [Delete transaction](https://docs.hyperline.co/api-reference/endpoints/invoices->-transactions/delete-transaction.md): Delete a transaction linked to an existing invoice. Only applies to scheduled transaction.
- [Charge invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/charge-invoice.md): Manually trigger the payment of the invoice.
- [Create credit note](https://docs.hyperline.co/api-reference/endpoints/invoices/create-credit-note.md): Create a credit note for an existing invoice.
- [Create invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/create-invoice.md): Create a new invoice.
- [Create invoices](https://docs.hyperline.co/api-reference/endpoints/invoices/create-invoices.md): Create new invoices in batch (max 50 items).
- [Delete invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/delete-invoice.md): Delete an invoice in `draft` status or imported from an external source. For other statuses, the `POST /v1/invoices/{id}/void` endpoint must be used.
- [Download invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/download-invoice.md): Download the PDF of an existing invoice.
- [Get invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/get-invoice.md): Retrieve the details of an existing invoice.
- [Get invoices](https://docs.hyperline.co/api-reference/endpoints/invoices/get-invoices.md): Retrieve all existing invoices. By default, invoices with status `open` are not included.
- [Mark as uncollectible](https://docs.hyperline.co/api-reference/endpoints/invoices/mark-as-uncollectible.md): Mark an invoice as uncollectible, useful for keeping track of bad debts that can be written off for accounting purposes.
- [Update invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/update-invoice.md): Update an invoice in draft or grace_period status.
- [Upload PDF to invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/upload-pdf-to-invoice.md): Upload a PDF file to an existing invoice.
- [Validate draft invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/validate-draft-invoice.md): Send a draft invoice for payment, set the status to `to_pay` and its number. This is not reversible.
- [Void invoice](https://docs.hyperline.co/api-reference/endpoints/invoices/void-invoice.md): Void an invoice in a `to_pay` status. This action generates a corresponding credit note.
- [Create invoicing entity](https://docs.hyperline.co/api-reference/endpoints/invoicing-entities/create-invoicing-entity.md): Create a new invoicing entity to send invoices from.
- [Delete invoicing entity](https://docs.hyperline.co/api-reference/endpoints/invoicing-entities/delete-invoicing-entity.md): Soft deletes an invoicing entity. This action won't delete the associated invoices.
- [Get invoicing entities](https://docs.hyperline.co/api-reference/endpoints/invoicing-entities/get-invoicing-entities.md): Retrieve all invoicing entities for your current client.
- [Get invoicing entity](https://docs.hyperline.co/api-reference/endpoints/invoicing-entities/get-invoicing-entity.md): Retrieve a specific invoicing entity.
- [Update invoicing entity](https://docs.hyperline.co/api-reference/endpoints/invoicing-entities/update-invoicing-entity.md): Update an existing invoicing entity.
- [Authorize](https://docs.hyperline.co/api-reference/endpoints/oauth2/authorize.md): Redirects the user to the Hyperline's login page, and grants authorization to your integration.
- [Generate tokens](https://docs.hyperline.co/api-reference/endpoints/oauth2/generate-tokens.md): Exchange an auth code received at the authorize endpoint for an actual access token, or refresh it.
- [Get user info](https://docs.hyperline.co/api-reference/endpoints/oauth2/get-user-info.md): Returns the user information associated with an access token.
- [Revoke token](https://docs.hyperline.co/api-reference/endpoints/oauth2/revoke-token.md): Revoke a refresh token. Once revoked the token can not be used anymore.
- [Get organisation](https://docs.hyperline.co/api-reference/endpoints/organisations/get-organisation.md): Retrieve the details of an existing organisation.
- [Patch organisation](https://docs.hyperline.co/api-reference/endpoints/organisations/patch-organisation.md): Update the details of an existing organisation.
- [Create payment](https://docs.hyperline.co/api-reference/endpoints/payments/create-payment.md): Initiate a new payment (limited to one-time): generate an invoice and charge it directly or with a checkout session
- [Get plan](https://docs.hyperline.co/api-reference/endpoints/plans/get-plan.md): Retrieve the details of an existing plan.
- [Get plans](https://docs.hyperline.co/api-reference/endpoints/plans/get-plans.md): Retrieve all existing plans.
- [Delete price configuration](https://docs.hyperline.co/api-reference/endpoints/price-configurations/delete-price-configuration.md): Delete an existing price configuration.
- [Get price configurations](https://docs.hyperline.co/api-reference/endpoints/price-configurations/get-price-configurations.md): Retrieve all existing price configurations.
- [Update prices](https://docs.hyperline.co/api-reference/endpoints/price-configurations/update-prices.md): Update prices of an existing price configuration.
- [Archive product](https://docs.hyperline.co/api-reference/endpoints/products/archive-product.md): Archive an existing product.