> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/maxio.md).

# Maxio

Manage customers, subscriptions, invoices, refunds, and billing events in Maxio Advanced Billing.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Maxio     | API key        |

#### Maxio

Connect a Maxio Advanced Billing site to manage customers, subscriptions, invoices, refunds, and billing events.

**Set up in Maxio**

1. Prepare the Maxio account or service that the workflow will access. Grant access to the required resources and operations.
2. **API key:** A full-access Advanced Billing API key for this site. Admin users can copy site API keys from Maxio's API Keys settings.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Maxio**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field  | Required                 | What to enter                                                                                                                                                                                                                        |
| -------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Hosting region | Optional / as applicable | The hosting region for this Maxio Advanced Billing site. Choose US for \*.chargify.com sites or EU for \*.ebilling.maxio.com sites.                                                                                                  |
| Site subdomain | Yes                      | The site label before '.chargify.com' or '.ebilling.maxio.com'. Enter only the label, for example 'acme', without a scheme, path, or domain suffix.                                                                                  |
| API key        | Yes                      | A full-access Advanced Billing API key for this site. Admin users can copy site API keys from Maxio's API Keys settings. [Provider instructions](https://docs.maxio.com/hc/en-us/articles/24294819360525-Advanced-Billing-API-Keys). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Maxio** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Customer

Create a Maxio customer for subscription and invoice management.

**Inputs**

| Field                | Type    | Required | Description                                                      |
| -------------------- | ------- | -------- | ---------------------------------------------------------------- |
| First name           | string  | Yes      | The customer's given name.                                       |
| Last name            | string  | Yes      | The customer's family name.                                      |
| Email                | string  | Yes      | The customer's primary email address.                            |
| Customer reference   | string  | No       | Your unique identifier for this customer.                        |
| Organization         | string  | No       | The customer's company or organization.                          |
| Show advanced fields | boolean | No       | Reveal contact, address, locale, and tax fields. Default: false. |
| Phone                | string  | No       | A phone number for the customer.                                 |
| CC emails            | string  | No       | Email addresses copied on customer communications.               |
| Address              | string  | No       | The first line of the customer's shipping address.               |
| Address line 2       | string  | No       | Apartment, suite, or unit information.                           |
| City                 | string  | No       | The customer's shipping city.                                    |
| State or region code | string  | No       | The ISO subdivision code for the state or region.                |
| Postal code          | string  | No       | The customer's postal or ZIP code.                               |
| Country code         | string  | No       | The two-letter country code for the address.                     |
| Locale               | string  | No       | The language and region used for invoices.                       |
| VAT number           | string  | No       | The customer's VAT business identifier.                          |
| Tax exempt           | boolean | No       | Mark the customer as exempt from tax.                            |

**Outputs**

| Field              | Type     | Description                                |
| ------------------ | -------- | ------------------------------------------ |
| Customer ID        | integer  | The Maxio identifier for the new customer. |
| First name         | string   | The stored customer first name.            |
| Last name          | string   | The stored customer last name.             |
| Email              | string   | The stored customer email address.         |
| Customer reference | string   | The stored merchant reference.             |
| Created at         | datetime | When Maxio created the customer.           |

#### Create Subscription

Start recurring billing for an existing Maxio customer and product.

**Inputs**

| Field                  | Type            | Required | Description                                                                                                                      |
| ---------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| Customer               | select (string) | Yes      | The customer who will own the subscription. Options load from the selected connection.                                           |
| Product                | select (string) | Yes      | The product used for recurring billing. Options load from the selected connection.                                               |
| Price point            | select (string) | No       | A specific price point for the selected product. Options load from the selected connection.                                      |
| Payment profile        | select (string) | No       | An existing card or bank profile for automatic collection. Options load from the selected connection.                            |
| Collection method      | select (string) | No       | How Maxio collects payment for this subscription. Available values: Automatic, Remittance, Prepaid, Invoice. Default: automatic. |
| Show advanced fields   | boolean         | No       | Reveal the reference, first billing time, and net terms. Default: false.                                                         |
| Subscription reference | string          | No       | Your identifier for this subscription.                                                                                           |
| Next billing at        | datetime        | No       | Delay the first charge until this future time.                                                                                   |
| Net terms              | integer         | No       | Days until payment is due for invoice billing.                                                                                   |

**Outputs**

| Field                  | Type     | Description                                    |
| ---------------------- | -------- | ---------------------------------------------- |
| Subscription ID        | integer  | The Maxio identifier for the new subscription. |
| State                  | string   | The subscription's current billing state.      |
| Customer ID            | integer  | The customer who owns the subscription.        |
| Product handle         | string   | The subscribed product's API handle.           |
| Current period ends at | datetime | When the current billing period ends.          |
| Next assessment at     | datetime | When Maxio next assesses subscription charges. |

#### Create Invoice

Create an ad hoc invoice with one custom line item for a subscription.

**Inputs**

| Field                 | Type            | Required | Description                                                                                |
| --------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------ |
| Subscription          | select (string) | Yes      | The subscription that will receive the invoice. Options load from the selected connection. |
| Line item title       | string          | Yes      | A short name for the invoiced item.                                                        |
| Quantity              | string          | Yes      | The quantity billed on this line. Default: 1.                                              |
| Unit price            | string          | Yes      | The price per unit in the site's currency.                                                 |
| Line item description | textarea        | No       | Additional detail about the invoiced item.                                                 |
| Invoice status        | select (string) | No       | Create the invoice as open or draft. Available values: Open, Draft. Default: open.         |
| Show advanced fields  | boolean         | No       | Reveal tax, date, payment, and memo fields. Default: false.                                |
| Calculate tax         | boolean         | No       | Ask Maxio to calculate tax for this line.                                                  |
| Tax code              | string          | No       | The product tax code used by the site's tax service.                                       |
| Issue date            | date            | No       | The date Maxio issues the invoice.                                                         |
| Net terms             | integer         | No       | The number of days until the invoice is due. Minimum: 0.                                   |
| Memo                  | textarea        | No       | A custom memo shown on the invoice.                                                        |
| Payment instructions  | textarea        | No       | Instructions shown to the invoice recipient.                                               |

**Outputs**

| Field          | Type    | Description                                          |
| -------------- | ------- | ---------------------------------------------------- |
| Created        | boolean | Whether Maxio accepted the invoice creation request. |
| Invoice UID    | string  | The generated Maxio invoice identifier.              |
| Invoice number | string  | The customer-facing invoice number.                  |
| Status         | string  | The invoice's current status.                        |
| Total amount   | string  | The invoice total as a decimal string.               |
| Due amount     | string  | The unpaid amount as a decimal string.               |
| Due date       | date    | The invoice payment due date.                        |

#### Refund Invoice

Issue a full or partial refund for a payment on a Maxio invoice.

**Inputs**

| Field                       | Type            | Required | Description                                                                            |
| --------------------------- | --------------- | -------- | -------------------------------------------------------------------------------------- |
| Invoice                     | select (string) | Yes      | The invoice whose payment will be refunded. Options load from the selected connection. |
| Payment                     | select (string) | Yes      | The specific invoice payment to refund. Options load from the selected connection.     |
| Refund amount               | string          | Yes      | The amount to refund in the invoice currency.                                          |
| Refund memo                 | textarea        | Yes      | An audit note explaining the refund.                                                   |
| Show advanced fields        | boolean         | No       | Reveal external refund, credit, and invoice-voiding options. Default: false.           |
| External refund             | boolean         | No       | Record a refund that was paid outside Maxio. Default: false.                           |
| Apply account credit        | boolean         | No       | Create and apply credit to the invoice. Default: false.                                |
| Void fully refunded invoice | boolean         | No       | Void the invoice after a full refund without credit. Default: false.                   |

**Outputs**

| Field           | Type   | Description                                 |
| --------------- | ------ | ------------------------------------------- |
| Invoice UID     | string | The refunded invoice identifier.            |
| Invoice status  | string | The invoice status after the refund.        |
| Refunded amount | string | The invoice's total refunded amount.        |
| Paid amount     | string | The invoice's paid amount after the refund. |
| Due amount      | string | The amount due after the refund.            |

#### Cancel Subscription

Cancel a Maxio subscription immediately, at period end, or on a date.

**Inputs**

| Field                  | Type            | Required | Description                                                                                                     |
| ---------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| Subscription           | select (string) | Yes      | The subscription to cancel. Options load from the selected connection.                                          |
| Cancellation timing    | select (string) | Yes      | When the subscription should be canceled. Available values: Immediately, At end of period, On a scheduled date. |
| Cancellation time      | datetime        | No       | The date and time for a scheduled cancellation.                                                                 |
| Cancellation message   | textarea        | No       | An internal note explaining the cancellation.                                                                   |
| Reason code            | select (string) | No       | A configured Maxio reason for the cancellation. Options load from the selected connection.                      |
| Refund prepaid balance | boolean         | No       | Refund the remaining prepaid balance during cancellation. Default: true.                                        |

**Outputs**

| Field                     | Type     | Description                                        |
| ------------------------- | -------- | -------------------------------------------------- |
| Subscription id           | integer  | The canceled or scheduled subscription identifier. |
| State                     | string   | The subscription state after the request.          |
| Canceled at               | datetime | When Maxio canceled the subscription.              |
| Scheduled cancellation at | datetime | When Maxio plans to cancel the subscription.       |
| Cancellation message      | string   | The internal cancellation note stored by Maxio.    |

### Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

#### New Billing Event

Poll Maxio every five minutes for one selected customer, subscription, invoice, or refund event type. Polling is used because the HMAC shared key cannot be retrieved or provisioned through the endpoint API.

Choose the Maxio billing event type that should start this workflow.

**Configuration**

| Field      | Type            | Required | Description                                                                                                                                                                                                                                                                           |
| ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Event type | select (string) | Yes      | The Maxio event type that starts the workflow. Available values: Customer created, Signup succeeded, Signup failed, Invoice issued, Invoice pending, Refund succeeded, Refund failed, Subscription state changed, Pending cancellation changed. Default: subscription\_state\_change. |

**Event inputs**

| Field           | Type     | Required | Description                                   |
| --------------- | -------- | -------- | --------------------------------------------- |
| Event ID        | integer  | Yes      | The unique Maxio event identifier.            |
| Event type      | string   | Yes      | The event key reported by Maxio.              |
| Created at      | datetime | Yes      | When Maxio recorded the event.                |
| Customer ID     | integer  | No       | The related Maxio customer, when present.     |
| Subscription ID | integer  | No       | The related Maxio subscription, when present. |
| Invoice UID     | string   | No       | The related invoice identifier, when present. |

**Outputs**

| Field           | Type     | Description                                   |
| --------------- | -------- | --------------------------------------------- |
| Event ID        | integer  | The unique Maxio event identifier.            |
| Event type      | string   | The event key reported by Maxio.              |
| Created at      | datetime | When Maxio recorded the event.                |
| Customer ID     | integer  | The related Maxio customer, when present.     |
| Subscription ID | integer  | The related Maxio subscription, when present. |
| Invoice UID     | string   | The related invoice identifier, when present. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/maxio.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
