> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Tabs

> How to set up the Tabs connector, plus the actions that are available.

![Tabs](https://stackone-logos.com/api/tabs/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/tabs/changelog.md)

[63 actions](#actions) · 1 auth method

Accounting

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/tabs/guides/connector-profile/api-key.md)
>
> Uses a Tabs API key sent as-is in the Authorization header. Each key is scoped to a single Tabs entity and stays valid u...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/tabs/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

63 actions

ActionDescription

List Billing Terms`tabs_list_billing_terms`

Retrieve a paginated list of billing terms from Tabs

List Customer Contacts`tabs_list_customer_contacts`

Retrieve a paginated list of customer contacts from Tabs

Create Customer Contacts`tabs_create_customer_contacts`

Create customer contacts in Tabs

Update Customer Contact`tabs_update_customer_contact`

Update customer contact in Tabs

List Contracts`tabs_list_contracts`

Retrieve a paginated list of contracts from Tabs

Create Contract`tabs_create_contract`

Create a new contract for an existing Tabs customer, with an optional close date and external CRM ID

List Deleted Contracts`tabs_list_deleted_contracts`

Retrieve a paginated list of deleted contracts from Tabs

Get Contract By ID`tabs_get_contract`

Get contract by ID from Tabs

Update Contract`tabs_update_contract`

Update a contract's name, close date, external ID or external source type

Download Contract File`tabs_download_contract_file`

Download contract file from Tabs

Upload Contract File`tabs_upload_contract_file`

Upload contract file in Tabs

Delete Contract File`tabs_delete_contract_file`

Delete contract file from Tabs

Get Contract Obligation By ID`tabs_get_contract_obligation`

Get contract obligation by ID from Tabs

Perform Contract Action`tabs_perform_contract_action`

Perform contract action in Tabs

Upsert Obligation Custom Revenue`tabs_upsert_obligation_custom_revenue`

Upsert obligation custom revenue in Tabs

List Contract Billing Terms`tabs_list_contract_billing_terms`

Retrieve a paginated list of contract billing terms from Tabs

Create Contract Billing Term`tabs_create_contract_billing_term`

Create contract billing term in Tabs

Update Contract Billing Term`tabs_update_contract_billing_term`

Update contract billing term in Tabs

Create Commitments For A Contract`tabs_create_contract_commitments`

Create commitments for a contract in Tabs

Create Contract From File`tabs_create_contract_from_file`

Uploads a contract PDF and creates a new contract for it in one call

Create Contract Obligation`tabs_create_contract_obligation`

Returns 202 once the change is saved

Delete Contract Billing Term`tabs_delete_contract_billing_term`

Returns 202 once the change is saved

Delete Contract Metadata`tabs_delete_contract_metadata`

Delete contract metadata from Tabs

Get Contract Metadata`tabs_get_contract_metadata`

Get contract metadata from Tabs

Update Contract Metadata`tabs_update_contract_metadata`

Updates a contract's metadata by merging the provided top-level keys with the existing metadata

Delete Contract Obligation`tabs_delete_contract_obligation`

Returns 202 once the change is saved

Terminate Billing Term`tabs_terminate_billing_term`

Terminates a billing term as of the given end date

Update Contract Obligation`tabs_update_contract_obligation`

Returns 202 once the change is saved

Get Credit Memo By ID`tabs_get_credit_memo`

Get credit memo by ID from Tabs

List Credit Memos`tabs_list_credit_memos`

Retrieve a paginated list of credit memos from Tabs

Create Credit Memo`tabs_create_credit_memo`

Create credit memo in Tabs

Apply Credit Memo`tabs_apply_credit_memo`

Apply credit memo in Tabs

Get Customer By ID`tabs_get_customer`

Get customer by ID from Tabs

Delete Customer`tabs_delete_customer`

Delete customer from Tabs

List Customers`tabs_list_customers`

Retrieve a paginated list of customers from Tabs

Create Customer`tabs_create_customer`

Create a new customer in Tabs with billing contact, addresses, default currency, custom fields and tax details

Update Customer Names`tabs_update_customer_names`

Update customer names in Tabs

List Event Types`tabs_list_event_types`

Retrieve a paginated list of event types from Tabs

Create Event Type`tabs_create_event_type`

Create an event type in Tabs

Create An Event`tabs_create_event`

Creates a new usage event

Get All Events`tabs_list_events`

Fetches all usage events, and can be filtered as needed

Delete An Event`tabs_delete_event`

Deletes a usage event by creating a new deletion event that links back to the original event

Get Customer Invoice By ID`tabs_get_customer_invoice`

Get customer invoice by ID from Tabs

Get Invoice Generation Status`tabs_get_invoice_generation_status`

Check whether invoices are still generating for a customer

Download Invoice PDF`tabs_download_invoice_pdf`

Download invoice PDF from Tabs

Perform Invoice Action`tabs_perform_invoice_action`

Performs an action on an invoice

Get Invoice Payment By ID`tabs_get_invoice_payment`

Get invoice payment by ID from Tabs

Create Invoice Payment`tabs_create_invoice_payment`

Create invoice payment in Tabs

List Invoices`tabs_list_invoices`

Retrieve a paginated list of invoices from Tabs

Get Job By ID`tabs_get_job`

Check the status of an asynchronous Tabs job, such as an invoice send or void started by perform\_invoice\_action

Get Merchant Info`tabs_get_merchant_info`

Retrieve the Tabs merchant (entity) that the API key is scoped to

List Obligations`tabs_list_obligations`

Retrieve a paginated list of obligations from Tabs

List Payments`tabs_list_payments`

Retrieve a paginated list of payments from Tabs

Get A Product By ID`tabs_get_product`

Get a product by ID from Tabs

Update A Product`tabs_update_product`

Update a product's name, display name, status, ARR default, description or linked ERP item and class

List All Products For Merchant`tabs_list_products`

Retrieve a paginated list of all products for merchant from Tabs

Create A New Product`tabs_create_product`

Create a new product in Tabs

List Renewals`tabs_list_renewals`

Retrieve a paginated list of renewals from Tabs

Create A Renewal For A Contract`tabs_create_renewal`

Creates a `DRAFT` renewal for a processed contract. All terms are optional. A contract can have at most one renewal

Execute A Renewal`tabs_execute_renewal`

Starts executing the renewal asynchronously: the excluded billing terms are removed from the draft renewal contract, the...

Get A Renewal`tabs_get_renewal`

Retrieve a single contract renewal with its terms, notice period, length and price increase settings

Get ARR Report`tabs_get_arr_report`

Retrieve the annual recurring revenue (ARR) report, paginated and filterable by customer and period

List Revenue`tabs_list_revenue`

Cursor-paginated customer × month revenue rows


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.