### Products API

Source: https://vindi.github.io/api-docs/dist/index

Manages product information within the Vindi platform.

```APIDOC
## Products API

### Description
Provides endpoints for managing product data.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **query** (string) - Optional - Allows searching for products.

### Request Example
```json
{
  "query": "Widget"
}
```

### Response
#### Success Response (200)
- **products** (array) - A list of product objects.
  - **id** (integer) - The unique identifier for the product.
  - **name** (string) - The name of the product.
  - **description** (string) - The description of the product.

#### Response Example
```json
{
  "products": [
    {
      "id": 201,
      "name": "Widget",
      "description": "A high-quality widget."
    }
  ]
}
```
```

--------------------------------

### Plans API

Source: https://vindi.github.io/api-docs/dist/index

Manages subscription plans within the Vindi platform.

```APIDOC
## Plans API

### Description
Provides endpoints for managing subscription plans.

### Method
GET

### Endpoint
/plans

### Parameters
#### Query Parameters
- **query** (string) - Optional - Allows searching for plans.

### Request Example
```json
{
  "query": "Basic Plan"
}
```

### Response
#### Success Response (200)
- **plans** (array) - A list of plan objects.
  - **id** (integer) - The unique identifier for the plan.
  - **name** (string) - The name of the plan.
  - **price** (number) - The price of the plan.

#### Response Example
```json
{
  "plans": [
    {
      "id": 101,
      "name": "Basic Plan",
      "price": 29.99
    }
  ]
}
```
```

--------------------------------

### Import Batches API

Source: https://vindi.github.io/api-docs/dist/index

Manages batches for data imports.

```APIDOC
## Import Batches API

### Description
Provides endpoints for managing import batches.

### Method
GET

### Endpoint
/import_batches

### Response
#### Success Response (200)
- **import_batches** (array) - A list of import batch objects.
  - **id** (integer) - The unique identifier for the batch.
  - **status** (string) - The status of the import batch.
  - **created_at** (string) - The creation timestamp.

#### Response Example
```json
{
  "import_batches": [
    {
      "id": 1701,
      "status": "processing",
      "created_at": "2023-10-26T11:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Product Items API

Source: https://vindi.github.io/api-docs/dist/index

Manages items within a subscription.

```APIDOC
## Product Items API

### Description
Provides endpoints for managing items within a subscription.

### Method
GET

### Endpoint
/product_items

### Parameters
#### Query Parameters
- **subscription_id** (integer) - Optional - Filter items by subscription.

### Response
#### Success Response (200)
- **product_items** (array) - A list of product item objects.
  - **id** (integer) - The unique identifier for the product item.
  - **subscription_id** (integer) - The ID of the associated subscription.
  - **product_id** (integer) - The ID of the associated product.
  - **quantity** (integer) - The quantity of the product.

#### Response Example
```json
{
  "product_items": [
    {
      "id": 501,
      "subscription_id": 401,
      "product_id": 201,
      "quantity": 2
    }
  ]
}
```
```

--------------------------------

### Customers API

Source: https://vindi.github.io/api-docs/dist/index

Manages customer information within the Vindi platform.

```APIDOC
## Customers API

### Description
Provides endpoints for managing customer data.

### Method
GET

### Endpoint
/customers

### Parameters
#### Query Parameters
- **query** (string) - Optional - Allows searching for customers.

### Request Example
```json
{
  "query": "John Doe"
}
```

### Response
#### Success Response (200)
- **customers** (array) - A list of customer objects.
  - **id** (integer) - The unique identifier for the customer.
  - **name** (string) - The name of the customer.
  - **email** (string) - The email address of the customer.

#### Response Example
```json
{
  "customers": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  ]
}
```
```

--------------------------------

### Discounts API

Source: https://vindi.github.io/api-docs/dist/index

Manages discount codes and promotions.

```APIDOC
## Discounts API

### Description
Provides endpoints for managing discounts.

### Method
GET

### Endpoint
/discounts

### Response
#### Success Response (200)
- **discounts** (array) - A list of discount objects.
  - **id** (integer) - The unique identifier for the discount.
  - **code** (string) - The discount code.
  - **percentage** (number) - The discount percentage.

#### Response Example
```json
{
  "discounts": [
    {
      "id": 301,
      "code": "SUMMER10",
      "percentage": 10.0
    }
  ]
}
```
```

--------------------------------

### Users API

Source: https://vindi.github.io/api-docs/dist/index

Manages user accounts.

```APIDOC
## Users API

### Description
Provides endpoints for managing user accounts.

### Method
GET

### Endpoint
/users

### Parameters
#### Query Parameters
- **role_id** (integer) - Optional - Filter users by role.

### Response
#### Success Response (200)
- **users** (array) - A list of user objects.
  - **id** (integer) - The unique identifier for the user.
  - **name** (string) - The name of the user.
  - **email** (string) - The email address of the user.
  - **role_id** (integer) - The ID of the user's role.

#### Response Example
```json
{
  "users": [
    {
      "id": 2301,
      "name": "Bob",
      "email": "bob@example.com",
      "role_id": 2201
    }

```

--------------------------------

### Payment Methods API

Source: https://vindi.github.io/api-docs/dist/index

Manages payment methods available in the Vindi platform.

```APIDOC
## Payment Methods API

### Description
Provides endpoints for managing payment methods.

### Method
GET

### Endpoint
/payment_methods

### Response
#### Success Response (200)
- **payment_methods** (array) - A list of available payment method types.
  - **id** (string) - The identifier for the payment method type (e.g., 'credit_card', 'boleto').
  - **name** (string) - The display name of the payment method.

#### Response Example
```json
{
  "payment_methods": [
    {
      "id": "credit_card",
      "name": "Credit Card"
    },
    {
      "id": "boleto",
      "name": "Boleto Bancário"
    }
  ]
}
```
```

--------------------------------

### Export Batches API

Source: https://vindi.github.io/api-docs/dist/index

Manages batches for data exports.

```APIDOC
## Export Batches API

### Description
Provides endpoints for managing export batches.

### Method
GET

### Endpoint
/export_batches

### Response
#### Success Response (200)
- **export_batches** (array) - A list of export batch objects.
  - **id** (integer) - The unique identifier for the batch.
  - **status** (string) - The status of the export batch.
  - **created_at** (string) - The creation timestamp.

#### Response Example
```json
{
  "export_batches": [
    {
      "id": 1601,
      "status": "completed",
      "created_at": "2023-10-25T09:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Roles API

Source: https://vindi.github.io/api-docs/dist/index

Manages access roles for users.

```APIDOC
## Roles API

### Description
Provides endpoints for managing access roles.

### Method
GET

### Endpoint
/roles

### Response
#### Success Response (200)
- **roles** (array) - A list of role objects.
  - **id** (integer) - The unique identifier for the role.
  - **name** (string) - The name of the role (e.g., 'admin', 'viewer').

#### Response Example
```json
{
  "roles": [
    {
      "id": 2201,
      "name": "admin"
    },
    {
      "id": 2202,
      "name": "viewer"
    }
  ]
}
```
```

--------------------------------

### Issues API

Source: https://vindi.github.io/api-docs/dist/index

Manages pending issues or exceptions.

```APIDOC
## Issues API

### Description
Provides endpoints for managing issues.

### Method
GET

### Endpoint
/issues

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filter issues by status (e.g., 'open', 'resolved').

### Response
#### Success Response (200)
- **issues** (array) - A list of issue objects.
  - **id** (integer) - The unique identifier for the issue.
  - **description** (string) - Description of the issue.
  - **status** (string) - The status of the issue.
  - **created_at** (string) - The creation timestamp.

#### Response Example
```json
{
  "issues": [
    {
      "id": 1801,
      "description": "Payment failed for customer X",
      "status": "open",
      "created_at": "2023-10-25T14:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Periods API

Source: https://vindi.github.io/api-docs/dist/index

Manages billing periods for subscriptions.

```APIDOC
## Periods API

### Description
Provides endpoints for managing billing periods.

### Method
GET

### Endpoint
/periods

### Parameters
#### Query Parameters
- **subscription_id** (integer) - Optional - Filter periods by subscription.

### Response
#### Success Response (200)
- **periods** (array) - A list of period objects.
  - **id** (integer) - The unique identifier for the period.
  - **subscription_id** (integer) - The ID of the associated subscription.
  - **start_date** (string) - The start date of the period.
  - **end_date** (string) - The end date of the period.

#### Response Example
```json
{
  "periods": [
    {
      "id": 601,
      "subscription_id": 401,
      "start_date": "2023-10-01",
      "end_date": "2023-10-31"
    }
  ]
}
```
```

--------------------------------

### Subscriptions API

Source: https://vindi.github.io/api-docs/dist/index

Manages customer subscriptions.

```APIDOC
## Subscriptions API

### Description
Provides endpoints for managing subscriptions.

### Method
GET

### Endpoint
/subscriptions

### Parameters
#### Query Parameters
- **customer_id** (integer) - Optional - Filter subscriptions by customer.

### Response
#### Success Response (200)
- **subscriptions** (array) - A list of subscription objects.
  - **id** (integer) - The unique identifier for the subscription.
  - **customer_id** (integer) - The ID of the associated customer.
  - **plan_id** (integer) - The ID of the associated plan.
  - **status** (string) - The current status of the subscription.

#### Response Example
```json
{
  "subscriptions": [
    {
      "id": 401,
      "customer_id": 1,
      "plan_id": 101,
      "status": "active"
    }
  ]
}
```
```

--------------------------------

### Financial Movements API

Source: https://vindi.github.io/api-docs/dist/index

Manages financial movements within the platform.

```APIDOC
## Financial Movements API

### Description
Provides endpoints for managing financial movements.

### Method
GET

### Endpoint
/movements

### Parameters
#### Query Parameters
- **type** (string) - Optional - Filter movements by type (e.g., 'income', 'expense').

### Response
#### Success Response (200)
- **movements** (array) - A list of financial movement objects.
  - **id** (integer) - The unique identifier for the movement.
  - **type** (string) - The type of movement.
  - **amount** (number) - The movement amount.
  - **date** (string) - The date of the movement.
  - **description** (string) - Description of the movement.

#### Response Example
```json
{
  "movements": [
    {
      "id": 1401,
      "type": "income",
      "amount": 59.98,
      "date": "2023-10-27",
      "description": "Payment received for invoice INV-00123"
    }
  ]
}
```
```

--------------------------------

### Payment Profiles API

Source: https://vindi.github.io/api-docs/dist/index

Manages customer payment profiles.

```APIDOC
## Payment Profiles API

### Description
Provides endpoints for managing customer payment profiles.

### Method
GET

### Endpoint
/payment_profiles

### Parameters
#### Query Parameters
- **customer_id** (integer) - Optional - Filter profiles by customer.

### Response
#### Success Response (200)
- **payment_profiles** (array) - A list of payment profile objects.
  - **id** (integer) - The unique identifier for the payment profile.
  - **customer_id** (integer) - The ID of the associated customer.
  - **payment_method_id** (string) - The identifier of the payment method.
  - **details** (object) - Specific details of the payment method (e.g., last 4 digits of card).

#### Response Example
```json
{
  "payment_profiles": [
    {
      "id": 1101,
      "customer_id": 1,
      "payment_method_id": "credit_card",
      "details": {
        "last_digits": "1111"
      }
    }
  ]
}
```
```

--------------------------------

### Usage Records API

Source: https://vindi.github.io/api-docs/dist/index

Manages usage records for services.

```APIDOC
## Usage Records API

### Description
Provides endpoints for managing usage records.

### Method
GET

### Endpoint
/usages

### Parameters
#### Query Parameters
- **subscription_id** (integer) - Optional - Filter usage by subscription.

### Response
#### Success Response (200)
- **usages** (array) - A list of usage record objects.
  - **id** (integer) - The unique identifier for the usage record.
  - **subscription_id** (integer) - The ID of the associated subscription.
  - **description** (string) - Description of the usage.
  - **quantity** (number) - The amount of usage.
  - **timestamp** (string) - The time the usage was recorded.

#### Response Example
```json
{
  "usages": [
    {
      "id": 1201,
      "subscription_id": 401,
      "description": "API calls",
      "quantity": 500,
      "timestamp": "2023-10-26T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Bills API

Source: https://vindi.github.io/api-docs/dist/index

Manages generated bills for subscriptions.

```APIDOC
## Bills API

### Description
Provides endpoints for managing bills.

### Method
GET

### Endpoint
/bills

### Parameters
#### Query Parameters
- **subscription_id** (integer) - Optional - Filter bills by subscription.

### Response
#### Success Response (200)
- **bills** (array) - A list of bill objects.
  - **id** (integer) - The unique identifier for the bill.
  - **subscription_id** (integer) - The ID of the associated subscription.
  - **due_date** (string) - The due date of the bill.
  - **amount** (number) - The total amount of the bill.
  - **status** (string) - The status of the bill.

#### Response Example
```json
{
  "bills": [
    {
      "id": 701,
      "subscription_id": 401,
      "due_date": "2023-10-15",
      "amount": 59.98,
      "status": "pending"
    }
  ]
}
```
```

--------------------------------

### Notifications API

Source: https://vindi.github.io/api-docs/dist/index

Manages notifications sent to users or system.

```APIDOC
## Notifications API

### Description
Provides endpoints for managing notifications.

### Method
GET

### Endpoint
/notifications

### Parameters
#### Query Parameters
- **read** (boolean) - Optional - Filter notifications by read status.

### Response
#### Success Response (200)
- **notifications** (array) - A list of notification objects.
  - **id** (integer) - The unique identifier for the notification.
  - **message** (string) - The notification message.
  - **read** (boolean) - Whether the notification has been read.
  - **created_at** (string) - The creation timestamp.

#### Response Example
```json
{
  "notifications": [
    {
      "id": 1901,
      "message": "A new bill has been generated.",
      "read": false,
      "created_at": "2023-10-27T08:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Charges API

Source: https://vindi.github.io/api-docs/dist/index

Manages charges related to bills.

```APIDOC
## Charges API

### Description
Provides endpoints for managing charges.

### Method
GET

### Endpoint
/charges

### Parameters
#### Query Parameters
- **bill_id** (integer) - Optional - Filter charges by bill.

### Response
#### Success Response (200)
- **charges** (array) - A list of charge objects.
  - **id** (integer) - The unique identifier for the charge.
  - **bill_id** (integer) - The ID of the associated bill.
  - **amount** (number) - The charge amount.
  - **status** (string) - The status of the charge.

#### Response Example
```json
{
  "charges": [
    {
      "id": 901,
      "bill_id": 701,
      "amount": 59.98,
      "status": "paid"
    }
  ]
}
```
```

--------------------------------

### Bill Items API

Source: https://vindi.github.io/api-docs/dist/index

Manages items included in a bill.

```APIDOC
## Bill Items API

### Description
Provides endpoints for managing items within a bill.

### Method
GET

### Endpoint
/bill_items

### Parameters
#### Query Parameters
- **bill_id** (integer) - Optional - Filter items by bill.

### Response
#### Success Response (200)
- **bill_items** (array) - A list of bill item objects.
  - **id** (integer) - The unique identifier for the bill item.
  - **bill_id** (integer) - The ID of the associated bill.
  - **product_item_id** (integer) - The ID of the associated product item.
  - **description** (string) - Description of the item.
  - **amount** (number) - The amount for this item.

#### Response Example
```json
{
  "bill_items": [
    {
      "id": 801,
      "bill_id": 701,
      "product_item_id": 501,
      "description": "Subscription product widget",
      "amount": 29.99
    }
  ]
}
```
```

--------------------------------

### Merchants API

Source: https://vindi.github.io/api-docs/dist/index

Manages merchant account information.

```APIDOC
## Merchants API

### Description
Provides endpoints for managing merchant information.

### Method
GET

### Endpoint
/merchants

### Response
#### Success Response (200)
- **merchants** (array) - A list of merchant objects.
  - **id** (integer) - The unique identifier for the merchant.
  - **name** (string) - The name of the merchant.
  - **email** (string) - The email address of the merchant.

#### Response Example
```json
{
  "merchants": [
    {
      "id": 2001,
      "name": "Example Merchant Inc.",
      "email": "contact@examplemerchant.com"
    }
  ]
}
```
```

--------------------------------

### Merchant Users API

Source: https://vindi.github.io/api-docs/dist/index

Manages users associated with a merchant account.

```APIDOC
## Merchant Users API

### Description
Provides endpoints for managing users associated with merchants.

### Method
GET

### Endpoint
/merchant_users

### Parameters
#### Query Parameters
- **merchant_id** (integer) - Optional - Filter users by merchant.

### Response
#### Success Response (200)
- **merchant_users** (array) - A list of merchant user objects.
  - **id** (integer) - The unique identifier for the user.
  - **merchant_id** (integer) - The ID of the associated merchant.
  - **name** (string) - The name of the user.
  - **email** (string) - The email address of the user.

#### Response Example
```json
{
  "merchant_users": [
    {
      "id": 2101,
      "merchant_id": 2001,
      "name": "Alice",
      "email": "alice@examplemerchant.com"
    }
  ]
}
```
```

--------------------------------

### Invoices API

Source: https://vindi.github.io/api-docs/dist/index

Manages issued invoices (Notas Fiscais).

```APIDOC
## Invoices API

### Description
Provides endpoints for managing invoices (Notas Fiscais).

### Method
GET

### Endpoint
/invoices

### Parameters
#### Query Parameters
- **bill_id** (integer) - Optional - Filter invoices by bill.

### Response
#### Success Response (200)
- **invoices** (array) - A list of invoice objects.
  - **id** (integer) - The unique identifier for the invoice.
  - **bill_id** (integer) - The ID of the associated bill.
  - **invoice_number** (string) - The invoice number.
  - **issue_date** (string) - The date the invoice was issued.
  - **status** (string) - The status of the invoice.

#### Response Example
```json
{
  "invoices": [
    {
      "id": 1301,
      "bill_id": 701,
      "invoice_number": "INV-00123",
      "issue_date": "2023-10-27",
      "status": "issued"
    }
  ]
}
```
```

--------------------------------

### Messages API

Source: https://vindi.github.io/api-docs/dist/index

Manages messages related to operations or notifications.

```APIDOC
## Messages API

### Description
Provides endpoints for managing messages.

### Method
GET

### Endpoint
/messages

### Parameters
#### Query Parameters
- **type** (string) - Optional - Filter messages by type (e.g., 'notification', 'error').

### Response
#### Success Response (200)
- **messages** (array) - A list of message objects.
  - **id** (integer) - The unique identifier for the message.
  - **type** (string) - The type of message.
  - **content** (string) - The message content.
  - **timestamp** (string) - The time the message was created.

#### Response Example
```json
{
  "messages": [
    {
      "id": 1501,
      "type": "notification",
      "content": "Your subscription has been renewed.",
      "timestamp": "2023-10-26T12:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Transactions API

Source: https://vindi.github.io/api-docs/dist/index

Manages payment transactions.

```APIDOC
## Transactions API

### Description
Provides endpoints for managing payment transactions.

### Method
GET

### Endpoint
/transactions

### Parameters
#### Query Parameters
- **charge_id** (integer) - Optional - Filter transactions by charge.

### Response
#### Success Response (200)
- **transactions** (array) - A list of transaction objects.
  - **id** (integer) - The unique identifier for the transaction.
  - **charge_id** (integer) - The ID of the associated charge.
  - **payment_method_id** (string) - The identifier of the payment method used.
  - **amount** (number) - The transaction amount.
  - **status** (string) - The status of the transaction.

#### Response Example
```json
{
  "transactions": [
    {
      "id": 1001,
      "charge_id": 901,
      "payment_method_id": "credit_card",
      "amount": 59.98,
      "status": "success"
    }
  ]
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.