# Vayu docs ## Docs - [Accounting Reports](https://guide.withvayu.com/accounting-reports.md) - [AI Insights](https://guide.withvayu.com/ai-insights.md) - [Login by obtaining a new access token](https://guide.withvayu.com/api-reference/endpoints/auth/login-by-obtaining-a-new-access-token.md): This endpoint is designed to acquire a temporary access token. Submit the auth token in the request body to obtain a new access token. Use this new token for subsequent API calls. Token is set to expire every hour. - [Create Catalog product](https://guide.withvayu.com/api-reference/endpoints/catalog-products/create-catalog-product.md): Create a new Catalog product. - [Delete Catalog product](https://guide.withvayu.com/api-reference/endpoints/catalog-products/delete-catalog-product.md): Delete a Catalog product by id. - [Get Catalog product](https://guide.withvayu.com/api-reference/endpoints/catalog-products/get-catalog-product.md): Get a Catalog product by id. - [List Catalog products](https://guide.withvayu.com/api-reference/endpoints/catalog-products/list-catalog-products.md): Get a list of Catalog products. - [Update Catalog product](https://guide.withvayu.com/api-reference/endpoints/catalog-products/update-catalog-product.md): Update a Catalog product by id. - [Create Contract](https://guide.withvayu.com/api-reference/endpoints/contracts/create-contract.md): Create a new Contract. - [Delete Contract](https://guide.withvayu.com/api-reference/endpoints/contracts/delete-contract.md): Delete a Contract by id. - [Get Contract](https://guide.withvayu.com/api-reference/endpoints/contracts/get-contract.md): Get a Contract by id. - [Get contract by integration id](https://guide.withvayu.com/api-reference/endpoints/contracts/get-contract-by-integration-id.md): Use this endpoint to get a specific contract using its integration provider and identifier. - [List contracts](https://guide.withvayu.com/api-reference/endpoints/contracts/list-contracts.md): List contracts for the account. Optionally filter by customerId to retrieve contracts for a specific customer. - [Deduct credits from customer credit ledger](https://guide.withvayu.com/api-reference/endpoints/credits/deduct-credits-from-customer-credit-ledger.md): This endpoint is used to deduct credits from the specified customer account. Submit the credit amount and customer ID in the request body to deduct the credits. The deducted credits will be subtracted from the customer's account. - [Grant credits to a customer credit ledger](https://guide.withvayu.com/api-reference/endpoints/credits/grant-credits-to-a-customer-credit-ledger.md): This endpoint is used to grant credits to a customer. Submit the credit amount and customer ID in the request body to grant the credits. The granted credits will be added to the customer's account. - [Retrieve credit ledger entries for customer.](https://guide.withvayu.com/api-reference/endpoints/credits/retrieve-credit-ledger-entries-for-customer.md): This endpoint is used to retrieve the credit ledger entries for a specific customer. - [Create Customer](https://guide.withvayu.com/api-reference/endpoints/customers/create-customer.md): Create a new Customer. - [Create Customer relation](https://guide.withvayu.com/api-reference/endpoints/customers/create-customer-relation.md): Create a new Customer relation. - [Delete Customer](https://guide.withvayu.com/api-reference/endpoints/customers/delete-customer.md): Delete a Customer by id. - [Get Customer](https://guide.withvayu.com/api-reference/endpoints/customers/get-customer.md): Get a Customer by id. - [Get customer by externalId](https://guide.withvayu.com/api-reference/endpoints/customers/get-customer-by-externalid.md): Use this endpoint to get a specific customer using its external Id. - [Get customer by integration id](https://guide.withvayu.com/api-reference/endpoints/customers/get-customer-by-integration-id.md): Use this endpoint to get a specific customer using its integration provider and identifier. - [Get customer by name](https://guide.withvayu.com/api-reference/endpoints/customers/get-customer-by-name.md): Use this endpoint to get a specific customer using its name. - [Get Customer relation](https://guide.withvayu.com/api-reference/endpoints/customers/get-customer-relation.md): Get a Customer relation by id. - [Get products consumptions by customer alias](https://guide.withvayu.com/api-reference/endpoints/customers/get-products-consumptions-by-customer-alias.md): Use this endpoint to get the products consumptions by the customer alias. - [Get products consumptions by customer id](https://guide.withvayu.com/api-reference/endpoints/customers/get-products-consumptions-by-customer-id.md): Use this endpoint to get the products consumptions by the customer id. - [List Customers](https://guide.withvayu.com/api-reference/endpoints/customers/list-customers.md): Get a list of Customers. - [Update Customer](https://guide.withvayu.com/api-reference/endpoints/customers/update-customer.md): Update a Customer by id. - [Delete an event by refId](https://guide.withvayu.com/api-reference/endpoints/events/delete-an-event-by-refid.md): Use this endpoint to remove a specific event using its reference ID. - [Delete events by refs](https://guide.withvayu.com/api-reference/endpoints/events/delete-events-by-refs.md): Delete multiple events, identified by ref, in a single request. - [Get event by refId](https://guide.withvayu.com/api-reference/endpoints/events/get-event-by-refid.md): Use this endpoint to get a specific event using its reference ID. - [Query events by timestamp period and optional event name](https://guide.withvayu.com/api-reference/endpoints/events/query-events-by-timestamp-period-and-optional-event-name.md): Fetch events occurring within a specified timestamp range. An optional event name can be provided to further filter the events. - [Submit a batch of events for ingestion](https://guide.withvayu.com/api-reference/endpoints/events/submit-a-batch-of-events-for-ingestion.md): Use this endpoint to send an array of events for processing and storage. Make sure to comply with the request schema for each event. - [Submit a batch of events for testing](https://guide.withvayu.com/api-reference/endpoints/events/submit-a-batch-of-events-for-testing.md): Use this endpoint to send an array of events for processing. Make sure to comply with the request schema for each event. NOTE: this is a dry run and will not result in actual storage of the events. - [Get Invoice](https://guide.withvayu.com/api-reference/endpoints/invoices/get-invoice.md): Get a Invoice by id. - [Get invoice payment status](https://guide.withvayu.com/api-reference/endpoints/invoices/get-invoice-payment-status.md): Use this endpoint to retrieve payment status information for a specific invoice, including payment status, amount due, amount paid, total, due date, paid date, and invoice PDF URL. - [List invoices](https://guide.withvayu.com/api-reference/endpoints/invoices/list-invoices.md): List invoices for the account. Optionally filter by customerId to retrieve invoices for a specific customer. - [Create Measurement](https://guide.withvayu.com/api-reference/endpoints/measurements/create-measurement.md): Create a new Measurement. - [Delete Measurement](https://guide.withvayu.com/api-reference/endpoints/measurements/delete-measurement.md): Delete a Measurement by id. - [Get Measurement](https://guide.withvayu.com/api-reference/endpoints/measurements/get-measurement.md): Get a Measurement by id. - [List Measurements](https://guide.withvayu.com/api-reference/endpoints/measurements/list-measurements.md): Get a list of Measurements. - [Delete Meter](https://guide.withvayu.com/api-reference/endpoints/meters/delete-meter.md): Delete a Meter by id. - [Get Meter](https://guide.withvayu.com/api-reference/endpoints/meters/get-meter.md): Get a Meter by id. - [List Meters](https://guide.withvayu.com/api-reference/endpoints/meters/list-meters.md): Get a list of Meters. - [Update Meter](https://guide.withvayu.com/api-reference/endpoints/meters/update-meter.md): Update a Meter by id. - [Get product consumption](https://guide.withvayu.com/api-reference/endpoints/product-consumptions/get-product-consumption.md): Use this action to get the consumption data for a product - [Subscribe to webhooks](https://guide.withvayu.com/api-reference/endpoints/webhooks/subscribe-to-webhooks.md): Use this endpoint to subscribe to webhooks and receive event notifications. - [Browsing Events](https://guide.withvayu.com/api-reference/pages/browsing-events.md): Query and filter ingested events - [Connecting to Vayu](https://guide.withvayu.com/api-reference/pages/connecting-to-vayu.md) - [Errors](https://guide.withvayu.com/api-reference/pages/errors.md): HTTP error codes and error response format - [Idempotency](https://guide.withvayu.com/api-reference/pages/idempotency.md): Safely retry API requests without creating duplicates - [Dry Run Ingestion](https://guide.withvayu.com/api-reference/pages/ingestion.md): Test event processing without storing data - [Vayu API](https://guide.withvayu.com/api-reference/pages/introduction.md): Full API reference for the Vayu billing platform - [Pagination](https://guide.withvayu.com/api-reference/pages/pagination.md): How to work with paginated list responses - [Product Structure](https://guide.withvayu.com/api-reference/pages/product-structure.md): How to define products in contracts - [Rate Limits](https://guide.withvayu.com/api-reference/pages/rate-limits.md): API rate limits and how to handle them - [SDK](https://guide.withvayu.com/api-reference/pages/sdk.md): Vayu client packages - [Sending events](https://guide.withvayu.com/api-reference/pages/sending-events.md): Sending events to Vayu - [Webhooks](https://guide.withvayu.com/api-reference/pages/webhooks.md): Receive real-time event notifications from Vayu - [Billing Reports](https://guide.withvayu.com/billing-reports.md) - [Change Log](https://guide.withvayu.com/documentation/change-log/changelog.md): New features and updates to Vayu - [Introduction](https://guide.withvayu.com/documentation/get-started/introduction.md): Billing with Vayu - [Quickstart](https://guide.withvayu.com/documentation/get-started/quickstart.md): The best way to get a sense of how easy Vayu is to use is to explore the platform's user guide. - [Adding a Customer](https://guide.withvayu.com/documentation/guides/customers/adding-a-customer.md) - [Customer Overview](https://guide.withvayu.com/documentation/guides/customers/customer-overview.md) - [Exporting Customer Data](https://guide.withvayu.com/documentation/guides/customers/export.md) - [Managing Customers](https://guide.withvayu.com/documentation/guides/customers/managing-customers.md): Create, update, and delete customer records through the UI and API - [Customer Portal](https://guide.withvayu.com/documentation/guides/customers/port.md): Provide customers secure access to view and download their invoices - [Related Entities](https://guide.withvayu.com/documentation/guides/customers/subsidiaries-and-related-entities.md): Create a hierarchy between entities and associate child entities - [Events](https://guide.withvayu.com/documentation/guides/data-metering/events.md) - [Pricing Events (Measurements)](https://guide.withvayu.com/documentation/guides/data-metering/pricing-events.md): Ingest and track usage measurements for usage-based billing - [Search Events](https://guide.withvayu.com/documentation/guides/data-metering/search-events.md): Query and filter usage events to analyze customer activity and troubleshoot billing - [Anrok](https://guide.withvayu.com/documentation/guides/integrations/anrok.md): Integrate Anrok with Vayu to support tax calculation and compliance - [HubSpot](https://guide.withvayu.com/documentation/guides/integrations/hubspot.md) - [NetSuite](https://guide.withvayu.com/documentation/guides/integrations/netsuite.md) - [QuickBooks](https://guide.withvayu.com/documentation/guides/integrations/quickbooks2.md) - [Rillet](https://guide.withvayu.com/documentation/guides/integrations/rillet.md) - [Salesforce](https://guide.withvayu.com/documentation/guides/integrations/salesforce.md) - [Snowflake](https://guide.withvayu.com/documentation/guides/integrations/snowflake.md) - [Stripe](https://guide.withvayu.com/documentation/guides/integrations/stripe.md) - [Xero](https://guide.withvayu.com/documentation/guides/integrations/xero.md) - [Dunning and Payment Reminders](https://guide.withvayu.com/documentation/guides/invoices/dunning.md): Automate payment reminders and manage collections for overdue invoices - [Invoices Overview](https://guide.withvayu.com/documentation/guides/invoices/invoices-overview.md) - [Invoices Portal](https://guide.withvayu.com/documentation/guides/invoices/invoices-portal.md): Share invoices with customers easily - [Payments](https://guide.withvayu.com/documentation/guides/invoices/mark.md): Manually update invoice payment status when payments are received outside of integrated payment systems - [One-Off Invoices](https://guide.withvayu.com/documentation/guides/invoices/untitled-page.md): Create standalone invoices outside of regular billing cycles for ad-hoc charges, adjustments, or special circumstances - [Credits](https://guide.withvayu.com/documentation/guides/invoices/untitled-page-1.md): Manage customer credit balances and apply them to invoices - [Credit ledger](https://guide.withvayu.com/documentation/guides/invoices/untitled-page-2.md): Track and audit all credit transactions for a customer - [Alerts and Notifications](https://guide.withvayu.com/documentation/guides/invoices/untitled-page-3.md): Configure alerts to stay informed about important billing events and customer activity - [Invoice PDF](https://guide.withvayu.com/documentation/guides/invoices/untitled-page-4.md): Generate, customize, and share PDF invoices with customers - [Assign Plan to Customer](https://guide.withvayu.com/documentation/guides/plans-and-pricing/assign-plan-to-customer.md) - [Base Amount and Commitment](https://guide.withvayu.com/documentation/guides/plans-and-pricing/base-amount-and-commitment.md) - [Contract Lifecycle ](https://guide.withvayu.com/documentation/guides/plans-and-pricing/contract-processing.md) - [Create Plan](https://guide.withvayu.com/documentation/guides/plans-and-pricing/create-plan.md): Plans holds the pricing, commercials, and terms defined for the customers. - [Fixed Fees](https://guide.withvayu.com/documentation/guides/plans-and-pricing/fixed-fees.md) - [Phases](https://guide.withvayu.com/documentation/guides/plans-and-pricing/phases.md): Create phased contract agreements where payment terms change throughout the contract lifecycle - [Plan Templates and Customer Contracts](https://guide.withvayu.com/documentation/guides/plans-and-pricing/plan-templates-and-contracts.md) - [Pricing & Product Line Items](https://guide.withvayu.com/documentation/guides/plans-and-pricing/pricing-and-product-line-items.md): Our pricing offers total flexibility. - [Plans & Pricing Overview](https://guide.withvayu.com/documentation/guides/plans-and-pricing/pricing-new-overview.md): Description of your new file. - [Usage-Based Fees](https://guide.withvayu.com/documentation/guides/plans-and-pricing/usage-based-fees.md) - [Members](https://guide.withvayu.com/documentation/guides/users/user-management.md): Learn about member types, permissions, and how to manage members in Vayu - [Subsidiaries](https://guide.withvayu.com/entities.md) - [Reports Overview](https://guide.withvayu.com/file.md) - [General](https://guide.withvayu.com/general.md) - [Invoice Preferences](https://guide.withvayu.com/invoice-preferences.md) - [PDF Extraction ](https://guide.withvayu.com/pdf-extraction.md) - [Usage](https://guide.withvayu.com/usage.md) - [Usage and Data Reports](https://guide.withvayu.com/usage-and-data-reports.md) ## OpenAPI Specs - [vy-openapi](https://guide.withvayu.com/config/vy-openapi.yml) ## Optional - [Website](https://withvayu.com/)