The Maxio connector lets your AI agent act in each user's Maxio account. Each user connects their own Maxio API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 90 tools.
- Tools
- 90
- What they doRead · write · destructive
- 56 · 31 · 356 read31 write3 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Maxio connection
In AgentKit > Connections, create a Maxio connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolmaxio_billing_portal_link_getGet a link that logs the customer straight into their billing portal.Read-onlyGet Billing Portal Link
Get a link that logs the customer straight into their billing portal. Returns the management URL and its expiration time. Use maxio_billing_portal_link_get to send or embed a portal link. The portal must be enabled first with maxio_billing_portal_enable.
Inputs
customer_idintegerrequired- The numeric Advanced Billing ID of the customer.
maxio_component_getGet one component in a product family by its ID or handle.Read-onlyGet Component
Get one component in a product family by its ID or handle. Returns the component with kind, unit name, pricing scheme, prices and default price point. Use maxio_component_get when you know the product family. Use maxio_component_get_by_handle when you only have the handle.
Inputs
component_idstringrequired- The component's ID, or its handle prefixed with handle:, for example handle:api-calls.
product_family_idintegerrequired- The numeric ID of the product family the component belongs to.
include_featuresboolean- When true, embeds the active feature catalog items for each result in a features array. Default value is false. Default: false
maxio_component_get_by_handleFind a component anywhere in the site by its handle.Read-onlyGet Component by Handle
Find a component anywhere in the site by its handle. Returns the component with id, kind, unit name, pricing and product family. Use maxio_component_get_by_handle when you do not know the product family. Use maxio_component_get with a family ID otherwise.
Inputs
handlestringrequired- The API handle of the component, for example api-calls.
maxio_component_price_point_getGet one price point of a component by ID or handle.Read-onlyGet Component Price Point
Get one price point of a component by ID or handle. Returns the price point with pricing scheme, price tiers and interval. Use maxio_component_price_point_get for one price point. Use maxio_component_price_points_list to browse.
Inputs
component_idstringrequired- The component's ID, or its handle prefixed with handle:.
price_point_idstringrequired- The price point's ID, or its handle prefixed with handle:.
currency_pricesboolean- Include an array of currency price data.
maxio_component_price_points_listList the price points of a component.Read-onlyList Component Price Points
List the price points of a component. Returns each price point with id, name, handle, pricing scheme and price tiers. Use maxio_component_price_points_list to find price points for allocations and usage. Use maxio_component_price_point_get for one.
Inputs
component_idintegerrequired- The Advanced Billing id of the component
currency_pricesboolean- Include an array of currency price data.
filter_typestring- Comma-separated price point types to return: catalog, default and/or custom.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of price points per page, up to 200. Default is 20.
maxio_components_listList components (add-ons, usage meters and seats) across all product families.Read-onlyList Components
List components (add-ons, usage meters and seats) across all product families. Returns a page of components with id, name, handle, kind, unit name, pricing scheme and product family. Use maxio_components_list to browse all components. Use maxio_product_family_components_list for one family, or maxio_component_get_by_handle for a handle.
Inputs
date_fieldstring- The type of filter you would like to apply to your search.one of
updated_atcreated_at end_datestring- Only return records whose date_field value is on or before this date (YYYY-MM-DD), up to 11:59:59 PM in the site time zone.
end_datetimestring- Only return records whose date_field value is at or before this exact time (YYYY-MM-DD HH:MM:SS). Overrides end_date when both are sent. Uses the site time zone unless a zone is included.
filter_idsstring- Comma-separated component IDs to return, for example 1,2,3.
include_archivedboolean- Include archived items.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of components per page, up to 200. Default is 20.
start_datestring- Only return records whose date_field value is on or after this date (YYYY-MM-DD), evaluated from midnight in the site time zone.
start_datetimestring- Only return records whose date_field value is at or after this exact time (YYYY-MM-DD HH:MM:SS). Overrides start_date when both are sent. Uses the site time zone unless a zone is included.
maxio_coupon_findFind a coupon by its code.Read-onlyFind Coupon by Code
Find a coupon by its code. Returns the coupon with id, name, discount, recurrence, end date and product family. Use maxio_coupon_find to look up a code. Use maxio_coupon_validate to check whether a code can be used, or maxio_coupon_get for a known coupon id.
Inputs
codestringrequired- The coupon code to look up.
currency_pricesboolean- Set to true to include per-currency prices on multi-currency sites.
product_family_idinteger- Limit the search to this product family ID.
maxio_coupon_getGet one coupon by its ID within a product family.Read-onlyGet Coupon
Get one coupon by its ID within a product family. Returns the coupon with name, code, discount, recurrence, end date and restrictions. Use maxio_coupon_get for a known coupon id. Use maxio_coupon_find when you have the code.
Inputs
coupon_idintegerrequired- The Advanced Billing id of the coupon
product_family_idintegerrequired- The Advanced Billing id of the product family to which the coupon belongs
currency_pricesboolean- Set to true to include per-currency prices on multi-currency sites.
maxio_coupon_usage_getGet usage statistics for a coupon, broken down by product.Read-onlyGet Coupon Usage
Get usage statistics for a coupon, broken down by product. Returns, per product, the number of signups, savings and revenue with the coupon. Use maxio_coupon_usage_get to measure coupon performance.
Inputs
coupon_idintegerrequired- The Advanced Billing id of the coupon.
product_family_idintegerrequired- The Advanced Billing id of the product family to which the coupon belongs.
maxio_coupon_validateCheck whether a coupon code is valid and can be used.Read-onlyValidate Coupon
Check whether a coupon code is valid and can be used. Returns the coupon if it is valid, or a 404 error explaining why it is not. Use maxio_coupon_validate before applying a code at signup or with maxio_subscription_coupons_apply.
Inputs
codestringrequired- The coupon code to validate.
product_family_idinteger- Validate the code within this product family ID.
maxio_coupons_listList coupons across all product families in the site.Read-onlyList Coupons
List coupons across all product families in the site. Returns a page of coupons with id, name, code, discount, recurrence, end date and product family. Use maxio_coupons_list to browse coupons. Use maxio_coupon_find for one code, or maxio_product_family_coupons_list for one family.
Inputs
currency_pricesboolean- Set to true to include per-currency prices on multi-currency sites.
filter_codesstring- Comma-separated coupon codes to return, for example SAVE20,FREETRIAL.
filter_idsstring- Comma-separated coupon IDs to return, for example 1,2,3.
filter_include_archivedboolean- Set to true to include archived coupons.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of coupons per page, up to 200. Default is 30.
maxio_custom_field_values_listList the custom field values (metadata) set on one subscription or customer.Read-onlyList Custom Field Values
List the custom field values (metadata) set on one subscription or customer. Returns each value with the custom field name, value and resource id. Use maxio_custom_field_values_list for one record. Use maxio_custom_fields_list for the field definitions.
Inputs
resource_idintegerrequired- The Advanced Billing ID of the subscription or customer.
resource_typestringrequired- Whether resource_id is a subscription or a customer.one of
subscriptionscustomers pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of values per page, up to 200. Default is 20.
maxio_custom_fields_listList the custom field definitions (metafields) for subscriptions or customers.Read-onlyList Custom Fields
List the custom field definitions (metafields) for subscriptions or customers. Returns each custom field with id, name, input type, enum options and scope. Use maxio_custom_fields_list to see which custom fields exist. Use maxio_custom_field_values_list for the values on one record.
Inputs
resource_typestringrequired- Whether to list custom fields for subscriptions or customers.one of
subscriptionscustomers directionstring- Sort direction: asc for oldest first, desc for newest first.one of
ascdesc namestring- Only return the custom field with this name.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of custom fields per page, up to 200. Default is 20.
maxio_customer_getGet one customer by its Advanced Billing customer ID.Read-onlyGet Customer
Get one customer by its Advanced Billing customer ID. Returns the customer object with contact details, address, tax settings, parent_id and portal status. Use maxio_customer_get when you have the numeric id. Use maxio_customer_get_by_reference for your own reference value, or maxio_customers_list to search.
Inputs
customer_idintegerrequired- The numeric Advanced Billing ID of the customer.
maxio_customer_get_by_referenceGet one customer by the reference value your application stored on it.Read-onlyGet Customer by Reference
Get one customer by the reference value your application stored on it. Returns the single matching customer object. Use maxio_customer_get_by_reference for an exact reference match. Use maxio_customer_get for a numeric id, or maxio_customers_list for a fuzzy search.
Inputs
referencestringrequired- The exact reference value set on the customer by your application.
maxio_customer_subscriptions_listList all subscriptions that belong to one customer.Read-onlyList Customer Subscriptions
List all subscriptions that belong to one customer. Returns an array of subscription objects with state, product, billing dates and balance. Use maxio_customer_subscriptions_list for one customer's subscriptions. Use maxio_subscriptions_list to filter subscriptions across the whole site.
Inputs
customer_idintegerrequired- The numeric Advanced Billing ID of the customer.
maxio_customers_listList customers in the Maxio Advanced Billing site, optionally filtered by a search query or a created/updated date range.Read-onlyList Customers
List customers in the Maxio Advanced Billing site, optionally filtered by a search query or a created/updated date range. Returns a page of customer objects with id, name, email, organization, reference and address. Use maxio_customers_list to browse or search. Use maxio_customer_get when you know the customer id, or maxio_customer_get_by_reference for your own reference value.
Inputs
date_fieldstring- Which timestamp the date filters apply to: created_at or updated_at.one of
updated_atcreated_at directionstring- Sort direction: asc for oldest first, desc for newest first.one of
ascdesc end_datestring- Only return records whose date_field value is on or before this date (YYYY-MM-DD), up to 11:59:59 PM in the site time zone.
end_datetimestring- Only return records whose date_field value is at or before this exact time (YYYY-MM-DD HH:MM:SS). Overrides end_date when both are sent. Uses the site time zone unless a zone is included.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of customers per page, up to 200. Default is 50.
qstring- Search text matched against customer email, Advanced Billing ID, reference, organization, first name and last name.
start_datestring- Only return records whose date_field value is on or after this date (YYYY-MM-DD), evaluated from midnight in the site time zone.
start_datetimestring- Only return records whose date_field value is at or after this exact time (YYYY-MM-DD HH:MM:SS). Overrides start_date when both are sent. Uses the site time zone unless a zone is included.
maxio_events_listList site activity events, such as signups, payments, renewals, state changes and component allocations.Read-onlyList Events
List site activity events, such as signups, payments, renewals, state changes and component allocations. Returns a page of events with id, key, message, subscription_id, customer_id and event-specific data. Use maxio_events_list for site-wide activity. Use maxio_subscription_events_list for one subscription, or maxio_invoice_events_list for invoice activity.
Inputs
date_fieldstring- Timestamp the date filters apply to (created_at).one of
created_at directionstring- Sort direction. Default is desc.one of
ascdesc end_datestring- Only return records whose date_field value is on or before this date (YYYY-MM-DD), up to 11:59:59 PM in the site time zone.
end_datetimestring- Only return records whose date_field value is at or before this exact time (YYYY-MM-DD HH:MM:SS). Overrides end_date when both are sent. Uses the site time zone unless a zone is included.
filterstring- Comma-separated event keys to return, for example signup_success,payment_success,renewal_failure.
max_idinteger- Only return events with an ID less than or equal to this one.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of events per page, up to 200. Default is 20.
since_idinteger- Only return events with an ID greater than or equal to this one.
start_datestring- Only return records whose date_field value is on or after this date (YYYY-MM-DD), evaluated from midnight in the site time zone.
start_datetimestring- Only return records whose date_field value is at or after this exact time (YYYY-MM-DD HH:MM:SS). Overrides start_date when both are sent. Uses the site time zone unless a zone is included.
maxio_invoice_events_listList invoice events such as issued, payment applied, credit note created, refund and void.Read-onlyList Invoice Events
List invoice events such as issued, payment applied, credit note created, refund and void. Returns a page of events with id, event_type, invoice and event-specific data. Use maxio_invoice_events_list to track invoice activity over time. Use maxio_events_list for subscription and site activity.
Inputs
event_typesstring- Comma-separated event types, for example issue_invoice,apply_payment,void_invoice.
invoice_uidstring- Only return events for this invoice or credit note uid.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of events per page, up to 200. Default is 100.
since_datestring- Only return events on or after this time (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ).
since_idinteger- Only return events with an ID greater than this one.
with_change_invoice_statusstring- Set to true to also return change_invoice_status events.
maxio_invoice_getGet one invoice by its uid.Read-onlyGet Invoice
Get one invoice by its uid. Returns the full invoice with line items, discounts, taxes, credits, payments, refunds and addresses. Use maxio_invoice_get for one invoice. Use maxio_invoices_list to find invoice uids.
Inputs
uidstringrequired- The unique identifier of the invoice (for example inv_8gd8tdhtd3hgr), not the public invoice number.
maxio_invoices_listList invoices across the site, filtered by status, subscription, customer, invoice number, product or a date range.Read-onlyList Invoices
List invoices across the site, filtered by status, subscription, customer, invoice number, product or a date range. Returns a page of invoices with uid, number, status, dates and amounts; line items, payments and other details are included when requested. Use maxio_invoices_list to find invoices. Use maxio_invoice_get for one invoice by uid.
Inputs
consolidation_levelstring- Comma-separated consolidation levels: none, parent and/or child.
creditsboolean- Set to true to include credits.
custom_fieldsboolean- Set to true to include custom fields.
customer_idsstring- Comma-separated customer IDs, for example 1,2,3.
date_fieldstring- Which invoice date the date filters apply to. Default is due_date.one of
created_atdue_dateissue_dateupdated_atpaid_date directionstring- Sort direction. Default is desc.one of
ascdesc discountsboolean- Set to true to include discounts.
end_datestring- Only return records whose date_field value is on or before this date (YYYY-MM-DD), up to 11:59:59 PM in the site time zone.
end_datetimestring- Only return records whose date_field value is at or before this exact time (YYYY-MM-DD HH:MM:SS). Overrides end_date when both are sent. Uses the site time zone unless a zone is included.
line_itemsboolean- Set to true to include line items.
numberstring- Comma-separated invoice numbers, for example 1234,1235.
pageinteger- Page number of results to return, starting at 1. Default is 1.
paymentsboolean- Set to true to include payments.
per_pageinteger- Number of invoices per page, up to 200. Default is 20.
product_idsstring- Comma-separated product IDs that appear on invoice line items, for example 23,34.
refundsboolean- Set to true to include refunds.
sortstring- Field to sort by. Default is number.one of
statustotal_amountdue_amountcreated_atupdated_atissue_datedue_datenumber start_datestring- Only return records whose date_field value is on or after this date (YYYY-MM-DD), evaluated from midnight in the site time zone.
start_datetimestring- Only return records whose date_field value is at or after this exact time (YYYY-MM-DD HH:MM:SS). Overrides start_date when both are sent. Uses the site time zone unless a zone is included.
statusstring- Only return invoices with this status.one of
draftopenpaidpendingvoidedcanceledprocessing subscription_group_uidstring- Only return consolidated invoices for this subscription group uid.
subscription_idinteger- Only return invoices for this subscription ID.
taxesboolean- Set to true to include taxes.
maxio_offer_getGet one offer by its ID.Read-onlyGet Offer
Get one offer by its ID. Returns the offer with product, price point, components, discounts and signup pages. Use maxio_offer_get for one offer. Use maxio_offers_list to browse.
Inputs
offer_idintegerrequired- The Advanced Billing ID of the offer.
maxio_offers_listList offers, which bundle a product, price point, components and coupons into one signup package.Read-onlyList Offers
List offers, which bundle a product, price point, components and coupons into one signup package. Returns each offer with id, name, handle, product and included items. Use maxio_offers_list to find an offer_id for maxio_subscription_create. Use maxio_offer_get for one offer.
Inputs
include_archivedboolean- Set to true to include archived offers.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of offers per page, up to 200. Default is 20.
maxio_payment_profile_getGet one stored payment method by its payment profile ID.Read-onlyGet Payment Profile
Get one stored payment method by its payment profile ID. Returns the payment profile with type, masked card or account number, expiration and billing address. Use maxio_payment_profile_get for one payment method. Use maxio_payment_profiles_list to find ids.
Inputs
payment_profile_idintegerrequired- The Advanced Billing ID of the payment profile.
maxio_payment_profiles_listList stored payment methods (cards and bank accounts), optionally for one customer.Read-onlyList Payment Profiles
List stored payment methods (cards and bank accounts), optionally for one customer. Returns each payment profile with id, type, masked number, expiration and customer id. Use maxio_payment_profiles_list to find a payment profile id. Use maxio_payment_profile_get for one.
Inputs
customer_idinteger- Only return payment profiles for this customer ID.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number per page, up to 200. Default is 20.
maxio_product_families_listList the product families in the site.Read-onlyList Product Families
List the product families in the site. Returns each family with id, name, handle and description. Use maxio_product_families_list to find a family id for product, component and coupon tools.
Inputs
date_fieldstring- The type of filter you would like to apply to your search. Use in query: date_field=created_at.one of
updated_atcreated_at end_datestring- Only return records whose date_field value is on or before this date (YYYY-MM-DD), up to 11:59:59 PM in the site time zone.
end_datetimestring- Only return records whose date_field value is at or before this exact time (YYYY-MM-DD HH:MM:SS). Overrides end_date when both are sent. Uses the site time zone unless a zone is included.
start_datestring- Only return records whose date_field value is on or after this date (YYYY-MM-DD), evaluated from midnight in the site time zone.
start_datetimestring- Only return records whose date_field value is at or after this exact time (YYYY-MM-DD HH:MM:SS). Overrides start_date when both are sent. Uses the site time zone unless a zone is included.
maxio_product_family_components_listList the components in one product family.Read-onlyList Product Family Components
List the components in one product family. Returns a page of components with id, name, handle, kind, unit name and pricing. Use maxio_product_family_components_list for one family. Use maxio_components_list across all families.
Inputs
product_family_idintegerrequired- The Advanced Billing id of the product family
date_fieldstring- The type of filter you would like to apply to your search. Use in query date_field=created_at.one of
updated_atcreated_at end_datestring- Only return records whose date_field value is on or before this date (YYYY-MM-DD), up to 11:59:59 PM in the site time zone.
end_datetimestring- Only return records whose date_field value is at or before this exact time (YYYY-MM-DD HH:MM:SS). Overrides end_date when both are sent. Uses the site time zone unless a zone is included.
filter_idsstring- Comma-separated component IDs to return, for example 1,2,3.
include_archivedboolean- Include archived items.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of components per page, up to 200. Default is 20.
start_datestring- Only return records whose date_field value is on or after this date (YYYY-MM-DD), evaluated from midnight in the site time zone.
start_datetimestring- Only return records whose date_field value is at or after this exact time (YYYY-MM-DD HH:MM:SS). Overrides start_date when both are sent. Uses the site time zone unless a zone is included.
maxio_product_family_coupons_listList the coupons in one product family.Read-onlyList Product Family Coupons
List the coupons in one product family. Returns a page of coupons with id, name, code, discount, recurrence and end date. Use maxio_product_family_coupons_list for one family. Use maxio_coupons_list across all families.
Inputs
product_family_idintegerrequired- The Advanced Billing id of the product family to which the coupon belongs
currency_pricesboolean- Set to true to include per-currency prices on multi-currency sites.
filter_codesstring- Comma-separated coupon codes to return, for example SAVE20,FREETRIAL.
filter_include_archivedboolean- Set to true to include archived coupons.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of coupons per page, up to 200. Default is 30.
maxio_product_family_getGet one product family by its ID.Read-onlyGet Product Family
Get one product family by its ID. Returns the family with id, name, handle, description and accounting code. Use maxio_product_family_get for one family. Use maxio_product_families_list to browse.
Inputs
product_family_idintegerrequired- The numeric Advanced Billing ID of the product family.
maxio_product_family_products_listList the products in one product family.Read-onlyList Product Family Products
List the products in one product family. Returns a page of products with id, name, handle, price and interval. Use maxio_product_family_products_list for one family. Use maxio_products_list across all families.
Inputs
product_family_idstringrequired- The product family's ID, or its handle prefixed with handle:, for example handle:saas-plans.
date_fieldstring- The type of filter you would like to apply to your search. Use in query: date_field=created_at.one of
updated_atcreated_at end_datestring- Only return records whose date_field value is on or before this date (YYYY-MM-DD), up to 11:59:59 PM in the site time zone.
end_datetimestring- Only return records whose date_field value is at or before this exact time (YYYY-MM-DD HH:MM:SS). Overrides end_date when both are sent. Uses the site time zone unless a zone is included.
filter_idsstring- Comma-separated product IDs to return, for example 1,2,3.
includestring- Set to prepaid_product_price_point to embed the prepaid price point on each product.one of
prepaid_product_price_point include_archivedboolean- Include archived products.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of products per page, up to 200. Default is 20.
start_datestring- Only return records whose date_field value is on or after this date (YYYY-MM-DD), evaluated from midnight in the site time zone.
start_datetimestring- Only return records whose date_field value is at or after this exact time (YYYY-MM-DD HH:MM:SS). Overrides start_date when both are sent. Uses the site time zone unless a zone is included.
maxio_product_getGet one product by its Advanced Billing product ID.Read-onlyGet Product
Get one product by its Advanced Billing product ID. Returns the product with name, handle, price, interval, trial, expiration and product family. Use maxio_product_get for a numeric id. Use maxio_product_get_by_handle for an API handle.
Inputs
product_idintegerrequired- The Advanced Billing id of the product
include_featuresboolean- When true, embeds the active feature catalog items for each result in a features array. Default value is false. Default: false
maxio_product_get_by_handleGet one product by its API handle.Read-onlyGet Product by Handle
Get one product by its API handle. Returns the product with name, handle, price, interval, trial and product family. Use maxio_product_get_by_handle when you have the handle. Use maxio_product_get for a numeric id.
Inputs
api_handlestringrequired- The API handle of the product, for example pro-monthly.
maxio_product_price_point_getGet one price point of a product by ID or handle.Read-onlyGet Product Price Point
Get one price point of a product by ID or handle. Returns the price point with price, interval, trial, initial charge and expiration settings. Use maxio_product_price_point_get for one price point. Use maxio_product_price_points_list to browse.
Inputs
price_point_idstringrequired- The price point's ID, or its handle prefixed with handle:.
product_idstringrequired- The product's ID, or its handle prefixed with handle:.
currency_pricesboolean- (Optional) If you have defined multiple currencies at the site level, you can pass ?currency_prices=true to include an array of currency price data in the response. If the product price point is set to use_site_exchange_rate: true, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency.
maxio_product_price_points_listList the price points of a product.Read-onlyList Product Price Points
List the price points of a product. Returns each price point with id, name, handle, price, interval, trial and type. Use maxio_product_price_points_list to find price point ids for subscriptions. Use maxio_product_price_point_get for one price point.
Inputs
product_idstringrequired- The product's ID, or its handle prefixed with handle:, for example handle:pro-monthly.
archivedboolean- Set to true to include archived price points.
currency_pricesboolean- (Optional) If you have defined multiple currencies at the site level, you can pass ?currency_prices=true to include an array of currency price data in the response. If the product price point is set to use_site_exchange_rate: true, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency.
filter_typestring- Comma-separated price point types to return: catalog, default and/or custom.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of price points per page, up to 200. Default is 10.
maxio_products_listList products across all product families in the site.Read-onlyList Products
List products across all product families in the site. Returns a page of products with id, name, handle, price, interval and product family. Use maxio_products_list to browse the catalog. Use maxio_product_family_products_list for one family, or maxio_product_get for one product.
Inputs
date_fieldstring- The type of filter you would like to apply to your search. Use in query: date_field=created_at.one of
updated_atcreated_at end_datestring- Only return records whose date_field value is on or before this date (YYYY-MM-DD), up to 11:59:59 PM in the site time zone.
end_datetimestring- Only return records whose date_field value is at or before this exact time (YYYY-MM-DD HH:MM:SS). Overrides end_date when both are sent. Uses the site time zone unless a zone is included.
filter_idsstring- Comma-separated product IDs to return, for example 1,2,3.
includestring- Set to prepaid_product_price_point to embed the prepaid price point on each product.one of
prepaid_product_price_point include_archivedboolean- Include archived products. Use in query: include_archived=true.
include_featuresboolean- When true, embeds the active feature catalog items for each result in a features array. Default value is false. Default: false
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of products per page, up to 200. Default is 20.
start_datestring- Only return records whose date_field value is on or after this date (YYYY-MM-DD), evaluated from midnight in the site time zone.
start_datetimestring- Only return records whose date_field value is at or after this exact time (YYYY-MM-DD HH:MM:SS). Overrides start_date when both are sent. Uses the site time zone unless a zone is included.
maxio_proforma_invoice_getGet one proforma invoice by its uid.Read-onlyGet Proforma Invoice
Get one proforma invoice by its uid. Returns the proforma invoice with line items, discounts, taxes and totals. Use maxio_proforma_invoice_get for one proforma invoice. Use maxio_subscription_proforma_invoices_list to find uids.
Inputs
proforma_invoice_uidstringrequired- The uid of the proforma invoice, for example pfm_8htcd29wcq3bw.
maxio_reason_codes_listList the churn reason codes configured for the site.Read-onlyList Reason Codes
List the churn reason codes configured for the site. Returns each reason code with id, code, description and position. Use maxio_reason_codes_list to get valid reason_code values for maxio_subscription_cancel.
Inputs
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of reason codes per page, up to 200. Default is 20.
maxio_site_getGet the settings of the Maxio Advanced Billing site the API key belongs to.Read-onlyGet Site
Get the settings of the Maxio Advanced Billing site the API key belongs to. Returns the site name, subdomain, currency, time zone, test mode flag, and tax and payment settings. Use maxio_site_get to confirm which site you are connected to. Use maxio_site_stats_get for revenue and subscription totals.
Inputs
This tool takes no inputs.
maxio_site_stats_getGet headline statistics for the site.Read-onlyGet Site Stats
Get headline statistics for the site. Returns total subscriptions, subscriptions today, total and today revenue, and counts of active, past due and canceled subscriptions. Use maxio_site_stats_get for a quick business overview. Use maxio_subscriptions_list for subscription-level detail.
Inputs
This tool takes no inputs.
maxio_subscription_component_allocations_listList the allocation history of a component on a subscription.Read-onlyList Component Allocations
List the allocation history of a component on a subscription. Returns each allocation with quantity, previous quantity, memo, proration and timestamp. Use maxio_subscription_component_allocations_list to audit quantity changes. Use maxio_subscription_component_usages_list for metered usage records.
Inputs
component_idintegerrequired- The Advanced Billing id of the component
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
pageinteger- Page number of results to return, starting at 1. Default is 1.
maxio_subscription_component_getGet one component on a subscription.Read-onlyGet Subscription Component
Get one component on a subscription. Returns the component with its kind, allocated quantity or unit balance, price point and pricing. Use maxio_subscription_component_get for one component. Use maxio_subscription_components_list for all components on the subscription.
Inputs
component_idstringrequired- The component's ID, or its handle prefixed with handle:.
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
maxio_subscription_component_usages_listList usage records for a metered or prepaid component on a subscription.Read-onlyList Component Usages
List usage records for a metered or prepaid component on a subscription. Returns each usage with id, quantity, memo and created_at. Use maxio_subscription_component_usages_list to audit recorded usage. Use maxio_subscription_component_usage_create to add usage.
Inputs
component_idstringrequired- The component's ID, or its handle prefixed with handle:.
subscription_id_or_referencestringrequired- The subscription ID, or its reference. A numeric string is read as an ID first.
max_idinteger- Returns usages with an id less than or equal to the one specified.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of usage records per page, up to 200. Default is 20.
since_datestring- Only return usage created on or after this date (YYYY-MM-DD).
since_idinteger- Returns usages with an id greater than or equal to the one specified.
until_datestring- Only return usage created on or before this date (YYYY-MM-DD).
maxio_subscription_components_listList the components on a subscription with their current quantities.Read-onlyList Subscription Components
List the components on a subscription with their current quantities. Returns each component with component_id, kind, allocated_quantity or unit_balance, price point and enabled state. Use maxio_subscription_components_list to see a subscription's add-ons and usage. Use maxio_subscription_component_get for one component.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
date_fieldstring- Timestamp the date filters apply to (updated_at).one of
updated_at directionstring- Sort direction: asc for oldest first, desc for newest first.one of
ascdesc end_datestring- Only return records whose date_field value is on or before this date (YYYY-MM-DD), up to 11:59:59 PM in the site time zone.
end_datetimestring- Only return records whose date_field value is at or before this exact time (YYYY-MM-DD HH:MM:SS). Overrides end_date when both are sent. Uses the site time zone unless a zone is included.
in_useboolean- Set to true to return only components currently in use on the subscription.
includestring- Comma-separated extra data to embed: subscription and/or historic_usages.
price_point_idsstring- Set to not_null to return only components that have a price point.one of
not_null product_family_idsstring- Comma-separated product family IDs to filter by, for example 1,2,3.
sortstring- Field to sort by: id or updated_at.one of
idupdated_at start_datestring- Only return records whose date_field value is on or after this date (YYYY-MM-DD), evaluated from midnight in the site time zone.
start_datetimestring- Only return records whose date_field value is at or after this exact time (YYYY-MM-DD HH:MM:SS). Overrides start_date when both are sent. Uses the site time zone unless a zone is included.
maxio_subscription_entitlements_listList the feature entitlements a subscription has through its product and components.Read-onlyList Subscription Entitlements
List the feature entitlements a subscription has through its product and components. Returns each entitled feature with its value and where it comes from. Use maxio_subscription_entitlements_list to check what a customer can access.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
maxio_subscription_events_listList activity events for one subscription, such as payments, renewals, state changes and allocations.Read-onlyList Subscription Events
List activity events for one subscription, such as payments, renewals, state changes and allocations. Returns a page of events with id, key, message and event-specific data. Use maxio_subscription_events_list for one subscription. Use maxio_events_list for the whole site.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
directionstring- Sort direction. Default is desc.one of
ascdesc filterstring- Comma-separated event keys to return, for example signup_success,payment_success,renewal_failure.
max_idinteger- Only return events with an ID less than or equal to this one.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of events per page, up to 200. Default is 20.
since_idinteger- Only return events with an ID greater than or equal to this one.
maxio_subscription_getGet one subscription by its Advanced Billing subscription ID.Read-onlyGet Subscription
Get one subscription by its Advanced Billing subscription ID. Returns the subscription with its state, product, customer, credit card or bank account, balances and billing dates. Use maxio_subscription_get when you know the id. Use maxio_subscription_get_by_reference for your own reference value, or maxio_subscriptions_list to search.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
includearray- Extra data to embed in the response: coupons and/or self_service_page_token.
maxio_subscription_get_by_referenceGet one subscription by the reference value your application stored on it.Read-onlyGet Subscription by Reference
Get one subscription by the reference value your application stored on it. Returns the single matching subscription object. Use maxio_subscription_get_by_reference for an exact reference match. Use maxio_subscription_get for a numeric id.
Inputs
referencestringrequired- The exact reference value set on the subscription by your application.
maxio_subscription_group_findFind the subscription group that a subscription belongs to.Read-onlyFind Subscription Group
Find the subscription group that a subscription belongs to. Returns the group with uid, scheme, customer and member subscriptions. Use maxio_subscription_group_find from a subscription id. Use maxio_subscription_group_get when you have the group uid.
Inputs
subscription_idstringrequired- The Advanced Billing ID of a subscription in the group.
maxio_subscription_group_getGet one subscription group by its uid.Read-onlyGet Subscription Group
Get one subscription group by its uid. Returns the group with scheme, customer, payment profile, member subscriptions and account balances. Use maxio_subscription_group_get for a known uid. Use maxio_subscription_group_find from a subscription id.
Inputs
group_uidstringrequired- The uid of the subscription group, for example grp_952mvqcnk53wq.
includearray- Set to ["current_billing_amount_in_cents"] to include the current billing amount.
maxio_subscription_groups_listList subscription groups, which bill several subscriptions together on one invoice.Read-onlyList Subscription Groups
List subscription groups, which bill several subscriptions together on one invoice. Returns each group with uid, scheme, primary subscription, customer and member subscription ids. Use maxio_subscription_groups_list to browse groups. Use maxio_subscription_group_find to find the group of one subscription.
Inputs
includearray- Set to ["account_balances"] to include account balance information for each group.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of groups per page, up to 200. Default is 20.
maxio_subscription_note_getGet one internal note on a subscription.Read-onlyGet Subscription Note
Get one internal note on a subscription. Returns the note with id, body, sticky flag and timestamps. Use maxio_subscription_note_get for one note. Use maxio_subscription_notes_list to find note ids.
Inputs
note_idintegerrequired- The Advanced Billing ID of the note.
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
maxio_subscription_notes_listList the internal notes on a subscription.Read-onlyList Subscription Notes
List the internal notes on a subscription. Returns each note with id, body, sticky flag and timestamps. Use maxio_subscription_notes_list to read all notes. Use maxio_subscription_note_get for one note.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of notes per page, up to 200. Default is 20.
maxio_subscription_prepayments_listList the prepayments recorded on a subscription.Read-onlyList Subscription Prepayments
List the prepayments recorded on a subscription. Returns each prepayment with id, amount, remaining amount, method, memo and dates. Use maxio_subscription_prepayments_list to see prepayment history. Use maxio_subscription_service_credits_list for service credits.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
filter_date_fieldstring- Which timestamp the date filters apply to: created_at or application_at.
filter_end_datestring- Only return prepayments on or before this date (YYYY-MM-DD).
filter_start_datestring- Only return prepayments on or after this date (YYYY-MM-DD).
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of prepayments per page, up to 200. Default is 20.
maxio_subscription_proforma_invoices_listList the proforma invoices (quotes for upcoming charges) of a subscription.Read-onlyList Subscription Proforma Invoices
List the proforma invoices (quotes for upcoming charges) of a subscription. Returns each proforma invoice with uid, status, dates and totals; line items and other details when requested. Use maxio_subscription_proforma_invoices_list to find proforma invoices. Use maxio_proforma_invoice_get for one.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
creditsboolean- Set to true to include credits.
custom_fieldsboolean- Set to true to include custom fields.
directionstring- Sort direction: asc for oldest first, desc for newest first.one of
ascdesc discountsboolean- Set to true to include discounts.
end_datestring- Only return proforma invoices due on or before this date (YYYY-MM-DD).
line_itemsboolean- Set to true to include line items.
pageinteger- Page number of results to return, starting at 1. Default is 1.
paymentsboolean- Set to true to include payments.
per_pageinteger- Number per page, up to 200. Default is 20.
start_datestring- Only return proforma invoices due on or after this date (YYYY-MM-DD).
statusstring- Only return proforma invoices with this status.one of
draftvoidedarchived taxesboolean- Set to true to include taxes.
maxio_subscription_service_credits_listList the service credits issued to a subscription.Read-onlyList Subscription Service Credits
List the service credits issued to a subscription. Returns each credit with id, amount, ending balance, entry type and memo. Use maxio_subscription_service_credits_list for credit history. Use maxio_subscription_service_credit_issue to add a credit.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
directionstring- Sort direction: asc for oldest first, desc for newest first.one of
ascdesc pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of service credits per page, up to 200. Default is 20.
maxio_subscriptions_listList subscriptions in the site, filtered by state, product, customer, coupon, collection method, search text or a date range.Read-onlyList Subscriptions
List subscriptions in the site, filtered by state, product, customer, coupon, collection method, search text or a date range. Returns a page of subscription objects with state, product, customer, billing period and balances. Use maxio_subscriptions_list to browse or filter. Use maxio_subscription_get for one subscription by id, or maxio_customer_subscriptions_list for one customer's subscriptions.
Inputs
collection_methodstring- Only return subscriptions with this payment collection method.one of
automaticremittanceprepaid couponinteger- Only return subscriptions with this coupon ID currently applied.
coupon_codestring- Only return subscriptions with this coupon code currently applied.
currenciesstring- Comma-separated currency codes to filter by, for example USD,EUR.
customer_idinteger- Only return subscriptions that belong to this customer ID.
date_fieldstring- Which subscription timestamp the date filters apply to.one of
current_period_ends_atcurrent_period_starts_atcreated_atactivated_atcanceled_atexpires_attrial_started_attrial_ended_atupdated_at directionstring- Sort direction: asc for oldest first, desc for newest first.one of
ascdesc end_datestring- Only return records whose date_field value is on or before this date (YYYY-MM-DD), up to 11:59:59 PM in the site time zone.
end_datetimestring- Only return records whose date_field value is at or before this exact time (YYYY-MM-DD HH:MM:SS). Overrides end_date when both are sent. Uses the site time zone unless a zone is included.
group_statusstring- Only return subscriptions that are in a subscription group (grouped) or not (ungrouped).one of
ungroupedgrouped includearray- Extra data to embed in each subscription: self_service_page_token, current_account_balance_in_cents, current_billing_amount or coupons.
pageinteger- Page number of results to return, starting at 1. Default is 1.
per_pageinteger- Number of subscriptions per page, up to 200. Default is 20.
productstring- Only return subscriptions on this product. Accepts the product ID or the exact product name (not the handle).
product_price_point_idinteger- Only return subscriptions on this product price point. Requires product.
qstring- Search text. Use q_scope to choose which fields are searched.
q_scopestring- Which field the q search text is matched against.one of
full_namefirst_namelast_nameorganizationcustomer_referencesubscription_reference sortstring- Field to sort by. Default is signup_date.one of
signup_dateperiod_startperiod_endnext_assessmentupdated_atcreated_attotal_paymentsidopen_balanceexpires_at start_datestring- Only return records whose date_field value is on or after this date (YYYY-MM-DD), evaluated from midnight in the site time zone.
start_datetimestring- Only return records whose date_field value is at or after this exact time (YYYY-MM-DD HH:MM:SS). Overrides start_date when both are sent. Uses the site time zone unless a zone is included.
statestring- Only return subscriptions in this state, for example active, trialing, past_due, canceled or on_hold.one of
activecanceledexpiredexpired_cardsexpired_cards_(live_subscriptions)expired_cards_(all_subscriptions)on_holdawaiting_signupawaiting_signup_datepast_duepending_cancellationpending_renewalprepaid_dunningsuspendedtrial_endedtrialingunpaid
maxio_billing_portal_enableEnable billing portal access for a customer, optionally emailing them an invitation.WriteEnable Billing Portal
Enable billing portal access for a customer, optionally emailing them an invitation. Returns the customer portal status. Use maxio_billing_portal_enable once per customer. Use maxio_billing_portal_link_get for a login link, or maxio_billing_portal_invitation_resend to email the invitation again.
Inputs
customer_idintegerrequired- The numeric Advanced Billing ID of the customer.
auto_invitestring- Set to 1 to email the customer an invitation. 0 or omitted sends no email.one of
01
maxio_billing_portal_invitation_resendResend the billing portal invitation email to a customer.WriteResend Billing Portal Invitation
Resend the billing portal invitation email to a customer. Returns when the invitation was sent and its status. Use maxio_billing_portal_invitation_resend when a customer lost the original invite. Use maxio_billing_portal_link_get for a direct login link.
Inputs
customer_idintegerrequired- The numeric Advanced Billing ID of the customer.
maxio_coupon_createCreate a percentage or flat-amount coupon in a product family.WriteCreate Coupon
Create a percentage or flat-amount coupon in a product family. Returns the new coupon with its id and code. Use maxio_coupon_create to add a discount code. Use maxio_coupon_update to change an existing coupon. Send either percentage or amount_in_cents.
Inputs
codestringrequired- Code customers enter, up to 255 characters of uppercase letters, numbers and the symbols % @ + - _ . Required when creating.
descriptionstringrequired- Description that can be shown to customers. Required when creating.
namestringrequired- Internal name of the coupon (not shown to customers), up to 255 characters. Required when creating.
product_family_idintegerrequired- The Advanced Billing id of the product family to which the coupon belongs
allow_negative_balanceboolean- Flat amount coupons only. Set to true to let unused discount carry forward as credit.
amount_in_centsinteger- Flat discount in integer cents. Send amount_in_cents or percentage, not both.
apply_on_cancel_at_end_of_periodboolean- Set to true to keep applying the coupon when a subscription is set to cancel at period end.
apply_on_subscription_expirationboolean- Set to true to apply the coupon on the charge made at subscription expiration.
compounding_strategystring- Stackable coupons only: compound (percentage applies to the already discounted price) or full-price.one of
compoundfull-price end_datestring- Last day new signups can use the coupon (YYYY-MM-DD).
exclude_mid_period_allocationsboolean- Set to true to not discount charges from mid-period component allocations.
percentagestring- Percentage discount as a string, for example 15 or 12.5. Send percentage or amount_in_cents, not both.
recurringboolean- Set to true to apply the discount on every renewal, not only the first charge.
restricted_componentsobject- Components the coupon is limited to, as an object whose keys are component IDs (or handle:<handle>) and values are true to restrict or false to unrestrict.
restricted_productsobject- Products the coupon is limited to, as an object whose keys are product IDs (or handle:<handle>) and values are true to restrict or false to unrestrict.
stackableboolean- Set to true to allow combining this coupon with other coupons on a subscription.
maxio_coupon_updateUpdate a coupon's name, code, description, discount, end date or product restrictions.WriteUpdate Coupon
Update a coupon's name, code, description, discount, end date or product restrictions. Only the fields you send are changed. Returns the updated coupon. Use maxio_coupon_update to edit a coupon. Use maxio_coupon_create to add a new one.
- Idempotent
Inputs
coupon_idintegerrequired- The Advanced Billing id of the coupon
product_family_idintegerrequired- The Advanced Billing id of the product family to which the coupon belongs
allow_negative_balanceboolean- Flat amount coupons only. Set to true to let unused discount carry forward as credit.
amount_in_centsinteger- Flat discount in integer cents. Send amount_in_cents or percentage, not both.
apply_on_cancel_at_end_of_periodboolean- Set to true to keep applying the coupon when a subscription is set to cancel at period end.
apply_on_subscription_expirationboolean- Set to true to apply the coupon on the charge made at subscription expiration.
codestring- Coupon code, up to 255 characters.
compounding_strategystring- Stackable coupons only: compound (percentage applies to the already discounted price) or full-price.one of
compoundfull-price descriptionstring- Description that can be shown to customers.
end_datestring- Last day new signups can use the coupon (YYYY-MM-DD).
exclude_mid_period_allocationsboolean- Set to true to not discount charges from mid-period component allocations.
namestring- Internal name of the coupon, up to 255 characters.
percentagestring- Percentage discount as a string, for example 15 or 12.5. Send percentage or amount_in_cents, not both.
recurringboolean- Set to true to apply the discount on every renewal, not only the first charge.
restricted_componentsobject- Components the coupon is limited to, as an object whose keys are component IDs (or handle:<handle>) and values are true to restrict or false to unrestrict.
restricted_productsobject- Products the coupon is limited to, as an object whose keys are product IDs (or handle:<handle>) and values are true to restrict or false to unrestrict.
stackableboolean- Set to true to allow combining this coupon with other coupons on a subscription.
maxio_customer_createCreate a customer in the Maxio Advanced Billing site without creating a subscription.WriteCreate Customer
Create a customer in the Maxio Advanced Billing site without creating a subscription. Returns the new customer object, including its Advanced Billing id. Use maxio_customer_create to add a customer on its own. Use maxio_subscription_create to create a customer and subscription in one call.
Inputs
emailstringrequired- The customer's email address. Invoices and receipts go here.
first_namestringrequired- The customer's first name.
last_namestringrequired- The customer's last name.
addressstring- First line of the street address.
address_2string- Second line of the street address, such as a suite or unit number.
cc_emailsstring- Comma-separated list of extra email addresses to copy on customer communications.
citystring- City of the address.
countrystring- Two-letter ISO 3166-1 country code, for example US.
entity_identifier_kindstring- Kind of tax or business identifier in entity_identifier_value: vat_eu (EU VAT, needs vat_country), national_tax (non-EU tax ID, needs vat_country), company_reg (company registration number), gln (13 digits), duns (9 digits) or lei (20 characters). Send together with entity_identifier_value.one of
vat_eunational_taxcompany_regglndunslei entity_identifier_valuestring- The customer's tax or business identifier. Send together with entity_identifier_kind.
localestring- Language and region used for invoices and emails, for example en-US or es-MX.
organizationstring- The customer's company or organization name.
parent_idinteger- The Advanced Billing ID of a parent customer, for customer hierarchies.
phonestring- The customer's phone number.
referencestring- Your own unique identifier for the customer (for example, the customer ID in your app). Must be unique within the site.
statestring- State or province code in ISO 3166-2 format, for example MA for Massachusetts.
surchargingboolean- Whether surcharging applies to this customer. Defaults to true. Only used on sites with surcharging control enabled.
tax_exemptboolean- Set to true if the customer is exempt from tax.
tax_exempt_reasonstring- Why the customer is tax exempt. Used with tax_exempt set to true.
vat_countrystring- Two-letter ISO country code that qualifies the tax ID. Required when entity_identifier_kind is vat_eu or national_tax.
vat_numberstring- Legacy VAT number field. Prefer entity_identifier_kind with entity_identifier_value.
zipstring- Postal or ZIP code.
maxio_customer_updateUpdate fields on an existing customer.WriteUpdate Customer
Update fields on an existing customer. Only the fields you send are changed. Returns the updated customer object. Use maxio_customer_update to change contact, address or tax details. Use maxio_customer_get first if you need current values.
- Idempotent
Inputs
customer_idintegerrequired- The numeric Advanced Billing ID of the customer.
addressstring- First line of the street address.
address_2string- Second line of the street address, such as a suite or unit number.
cc_emailsstring- Comma-separated list of extra email addresses to copy on customer communications.
citystring- City of the address.
countrystring- Two-letter ISO 3166-1 country code, for example US.
emailstring- The customer's email address. Invoices and receipts go here.
entity_identifier_kindstring- Kind of tax or business identifier in entity_identifier_value: vat_eu (EU VAT, needs vat_country), national_tax (non-EU tax ID, needs vat_country), company_reg, gln (13 digits), duns (9 digits) or lei (20 characters). Send together with entity_identifier_value.one of
vat_eunational_taxcompany_regglndunslei entity_identifier_valuestring- The customer's tax or business identifier. Send together with entity_identifier_kind.
first_namestring- The customer's first name.
last_namestring- The customer's last name.
localestring- Language and region used for invoices and emails, for example en-US or es-MX.
organizationstring- The customer's company or organization name.
parent_idinteger- The Advanced Billing ID of a parent customer, for customer hierarchies.
phonestring- The customer's phone number.
referencestring- Your own unique identifier for the customer (for example, the customer ID in your app). Must be unique within the site.
statestring- State or province code in ISO 3166-2 format, for example MA for Massachusetts.
surchargingboolean- Whether surcharging applies to this customer. Only used on sites with surcharging control enabled.
tax_exemptboolean- Set to true if the customer is exempt from tax.
tax_exempt_reasonstring- Why the customer is tax exempt. Used with tax_exempt set to true.
vat_countrystring- Two-letter ISO country code that qualifies the tax ID. Required when entity_identifier_kind is vat_eu or national_tax.
vat_numberstring- Legacy VAT number field. Prefer entity_identifier_kind with entity_identifier_value.
zipstring- Postal or ZIP code.
maxio_invoice_createCreate an ad hoc invoice on a subscription with custom line items, outside the normal billing cycle.WriteCreate Ad Hoc Invoice
Create an ad hoc invoice on a subscription with custom line items, outside the normal billing cycle. Returns the new invoice with uid, number, status and totals. Use maxio_invoice_create for one-off charges. Leave status as open (the default) to issue it right away.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
billing_addressobject- Billing address overriding the customer's default: first_name, last_name, phone, address, address_2, city, state, zip and country.
couponsarray- Coupons to apply. Each item has a code, or a percentage or amount with a description.
issue_datestring- Date the invoice is issued (YYYY-MM-DD). Defaults to today in the site time zone.
line_itemsarray- Line items to bill. Each item has a title, quantity and unit_price (strings with up to 8 decimals), and can set taxable, tax_code, period_range_start, period_range_end, description, or a product_id/component_id with price point.
memostring- Memo printed on the invoice, overriding the site's default.
net_termsinteger- Number of days until the invoice is due. Defaults to due on issue.
payment_instructionsstring- Payment instructions printed on the invoice.
shipping_addressobject- Shipping address overriding the customer's default, same fields as billing_address.
statusstring- Create the invoice as draft or open. Default is open.one of
draftopen
maxio_invoice_payment_recordRecord a payment against an invoice, such as an external check or wire, or apply a prepayment or service credit.WriteRecord Invoice Payment
Record a payment against an invoice, such as an external check or wire, or apply a prepayment or service credit. Returns the invoice with the payment applied. Use maxio_invoice_payment_record to mark an invoice paid. Use maxio_invoice_get to check the remaining due amount first.
Inputs
amountstringrequired- Payment amount as a decimal string, for example 10.50.
uidstringrequired- The unique identifier of the invoice, not the public invoice number.
detailsstring- Extra payment details, such as a check number. Only used for external payments.
memostring- Description attached to the payment. Only used for external payments.
methodstring- Payment method: credit_card, check, cash, money_order, ach or other. Defaults to other.one of
credit_cardcheckcashmoney_orderachother payment_profile_idinteger- ID of a payment profile to charge, when type is payment.
received_onstring- Date the payment was received (YYYY-MM-DD, in the past). Only used for external payments.
typestring- Source of the payment: external (default), prepayment, service_credit, or payment (charge a payment profile).one of
externalprepaymentservice_creditpayment
maxio_product_createCreate a product in a product family, with its price, billing interval and optional trial.WriteCreate Product
Create a product in a product family, with its price, billing interval and optional trial. Returns the new product with its id and default price point. Use maxio_product_create to add a plan to the catalog. Use maxio_product_price_point_create to add another price to an existing product.
Inputs
descriptionstringrequired- Product description shown to customers.
intervalintegerrequired- Number of interval_unit periods between charges, for example 1 with month.
interval_unitstringrequired- Unit of the billing interval: day or month.one of
daymonth namestringrequired- Product name.
price_in_centsintegerrequired- Recurring price in integer cents, for example 4900 for $49.00.
product_family_idstringrequired- The product family's ID, or its handle prefixed with handle:, for example handle:saas-plans.
accounting_codestring- Internal accounting code or SKU.
auto_create_signup_pageboolean- Set to true to create a public signup page for the product.
expiration_intervalinteger- Number of expiration_interval_unit periods after which the subscription expires.
expiration_interval_unitstring- Unit of the expiration interval: day, month or never.one of
daymonthnever handlestring- API handle for the product: lowercase letters, numbers, dashes and underscores.
tax_codestring- Tax code for the product, used by tax services such as AvaTax. Up to 25 characters.
trial_intervalinteger- Length of the trial in trial_interval_unit periods.
trial_interval_unitstring- Unit of the trial interval: day or month.one of
daymonth trial_price_in_centsinteger- Trial price in integer cents.
trial_typestring- What happens at trial end without a card on file: no_obligation (subscription ends) or payment_expected (it moves to past due).one of
no_obligationpayment_expected
maxio_product_family_createCreate a product family to group related products, components and coupons.WriteCreate Product Family
Create a product family to group related products, components and coupons. Returns the new product family with its id. Use maxio_product_family_create before adding products with maxio_product_create.
Inputs
namestringrequired- Name of the product family.
descriptionstring- Description of the product family.
handlestring- API handle for the product family.
surchargingboolean- Whether surcharging applies to products in this family. Defaults to true. Only used on sites with surcharging control enabled.
maxio_product_price_point_createAdd a new price point (an alternative price or interval) to a product.WriteCreate Product Price Point
Add a new price point (an alternative price or interval) to a product. Returns the new price point with its id and handle. Use maxio_product_price_point_create to offer another price for the same product, for example an annual plan.
Inputs
intervalintegerrequired- Number of interval_unit periods between charges, for example 1 with month.
interval_unitstringrequired- Unit of the billing interval: day or month.one of
daymonth namestringrequired- Name of the price point.
price_in_centsintegerrequired- Recurring price in integer cents, for example 4900 for $49.00.
product_idstringrequired- The product's ID, or its handle prefixed with handle:.
expiration_intervalinteger- Number of expiration_interval_unit periods after which the subscription expires.
expiration_interval_unitstring- Unit of the expiration interval: day, month or never.one of
daymonthnever handlestring- API handle for the price point.
initial_charge_after_trialboolean- Set to true to charge the initial charge after the trial instead of at signup.
initial_charge_in_centsinteger- One-time initial charge in integer cents.
trial_intervalinteger- Length of the trial in trial_interval_unit periods.
trial_interval_unitstring- Unit of the trial interval: day or month.one of
daymonth trial_price_in_centsinteger- Trial price in integer cents.
trial_typestring- What happens at trial end without a card on file: no_obligation (subscription ends) or payment_expected (it moves to past due).one of
no_obligationpayment_expected use_site_exchange_rateboolean- For multi-currency sites, set to true to convert prices with the site exchange rate.
maxio_product_updateUpdate a product's name, handle, description, accounting code, price or intervals.WriteUpdate Product
Update a product's name, handle, description, accounting code, price or intervals. Only the fields you send are changed. Returns the updated product. Use maxio_product_update to edit a product. Use maxio_product_price_point_create to add a new price instead of changing the default one.
- Idempotent
Inputs
product_idintegerrequired- The Advanced Billing id of the product
accounting_codestring- Internal accounting code or SKU.
auto_create_signup_pageboolean- Set to true to create a public signup page for the product.
descriptionstring- Product description shown to customers.
expiration_intervalinteger- Number of expiration_interval_unit periods after which the subscription expires.
expiration_interval_unitstring- Unit of the expiration interval: day, month or never.one of
daymonthnever handlestring- API handle for the product: lowercase letters, numbers, dashes and underscores.
intervalinteger- Number of interval_unit periods between charges, for example 1 with month.
interval_unitstring- Unit of the billing interval: day or month.one of
daymonth namestring- Product name.
price_in_centsinteger- Recurring price in integer cents, for example 4900 for $49.00.
tax_codestring- Tax code for the product, used by tax services such as AvaTax. Up to 25 characters.
trial_intervalinteger- Length of the trial in trial_interval_unit periods.
trial_interval_unitstring- Unit of the trial interval: day or month.one of
daymonth trial_price_in_centsinteger- Trial price in integer cents.
trial_typestring- What happens at trial end without a card on file: no_obligation (subscription ends) or payment_expected (it moves to past due).one of
no_obligationpayment_expected
maxio_subscription_component_allocateSet the quantity of a quantity-based or on/off component on a subscription, with proration.WriteAllocate Subscription Component
Set the quantity of a quantity-based or on/off component on a subscription, with proration. Returns the allocation with previous and new quantity, proration settings and payment details. Use maxio_subscription_component_allocate for seats and on/off add-ons. Use maxio_subscription_component_usage_create for metered usage.
Inputs
component_idintegerrequired- The Advanced Billing id of the component
quantitynumberrequired- New total quantity for the component. Use 1 or 0 for on/off components.
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
accrue_chargeboolean- Set to true to add an upgrade charge to the next renewal instead of charging now.
downgrade_creditstring- How to credit a decrease: full, prorated or none. Defaults to the component, then site setting.one of
fullproratednone initiate_dunningboolean- Set to true to start dunning if the immediate payment for the allocation fails.
memostring- A free-text memo recorded with this action.
price_point_idstring- Price point to charge the allocation at: its ID, or handle prefixed with handle:.
proration_downgrade_schemestring- Legacy downgrade proration scheme. Prefer downgrade_credit.
proration_upgrade_schemestring- Legacy upgrade proration scheme. Prefer upgrade_charge.
upgrade_chargestring- How to charge for an increase: full, prorated or none. Defaults to the component, then site setting.one of
fullproratednone
maxio_subscription_component_usage_createRecord metered usage for a metered or prepaid usage component on a subscription.WriteRecord Component Usage
Record metered usage for a metered or prepaid usage component on a subscription. Returns the usage record with id, quantity, memo and timestamp. Use maxio_subscription_component_usage_create for metered and prepaid usage. Use maxio_subscription_component_allocate for quantity-based components.
Inputs
component_idstringrequired- The component's ID, or its handle prefixed with handle:.
quantitynumberrequired- Amount of usage to record. Integer unless fractional quantities are enabled for the component. Negative values reduce usage.
subscription_id_or_referencestringrequired- The subscription ID, or its reference. A numeric string is read as an ID first.
memostring- A free-text memo recorded with this action.
price_point_idstring- Price point to rate the usage at: its ID, or handle prefixed with handle:.
maxio_subscription_coupons_applyAdd one or more coupon codes to an existing subscription.WriteApply Coupons to Subscription
Add one or more coupon codes to an existing subscription. Returns the subscription with the coupons applied. Use maxio_subscription_coupons_apply to add discounts. Use maxio_coupon_validate first to check a code, and maxio_subscription_coupon_remove to take one off.
Inputs
codesarrayrequired- Coupon codes to add. They are added to any coupons already on the subscription.
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
maxio_subscription_createCreate a subscription for an existing or new customer on a product, optionally with components, coupons and a payment method on file.WriteCreate Subscription
Create a subscription for an existing or new customer on a product, optionally with components, coupons and a payment method on file. Returns the new subscription with its state, customer, product and billing dates. Use maxio_subscription_create to sign a customer up. Use maxio_subscription_preview first to see the charges without creating anything. Needs a product (product_handle or product_id) and a customer (customer_id, customer_reference or customer_attributes). Card details must be tokenized with Maxio.js and are not accepted here.
Inputs
calendar_billingobject- Calendar billing settings, such as snap_day (1 to 28 or end) and calendar_billing_first_charge (prorated, immediate or delayed). Cannot be combined with next_billing_at.
componentsarray- Components to add at signup. Each item has a component_id (ID or handle:<handle>) and, depending on the component kind, allocated_quantity (quantity-based), unit_balance (metered) or enabled (on/off). An item can also set price_point_id.
coupon_codesarray- Coupon codes to apply to the subscription.
currencystring- Currency code for the subscription, for sites with multi-currency enabled.
custom_priceobject- A custom price point unique to this subscription, used instead of product_price_point_id. Needs price_in_cents, interval and interval_unit.
customer_attributesobject- Details for a new customer created with the subscription. Needs first_name, last_name and email; can also hold organization, reference, address fields, phone and metafields.
customer_idinteger- ID of an existing customer to subscribe. Send customer_id, customer_reference or customer_attributes.
customer_referencestring- Reference of an existing customer to subscribe. Send customer_id, customer_reference or customer_attributes.
defer_signupboolean- Set to true to create the subscription in the Awaiting Signup Date state.
expires_atstring- Date and time (ISO 8601) at which the subscription expires.
initial_billing_atstring- Future date and time (ISO 8601) at which the subscription starts. The subscription stays in Awaiting Signup until then.
metafieldsobject- Custom field values as key/value pairs. Unknown keys create new custom fields on the site.
net_termsstring- Number of days after the invoice date that a remittance invoice is due.
next_billing_atstring- Date and time of the next billing (ISO 8601). Used to align imported subscriptions with an existing billing date.
offer_idstring- ID of an offer to apply. Use instead of product and component details.
payment_collection_methodstring- How payments are collected: automatic (charge the payment method on file), remittance (send invoices to be paid manually), or prepaid.one of
automaticremittanceprepaidinvoice payment_profile_idinteger- ID of an existing card or bank account that belongs to the customer, used to pay for this subscription.
product_handlestring- API handle of the product to subscribe to. Send product_handle or product_id.
product_idinteger- ID of the product to subscribe to. Send product_id or product_handle.
product_price_point_handlestring- Handle of a specific price point on the product. Omit to use the product's default price point.
product_price_point_idinteger- ID of a specific price point on the product. Omit to use the product's default price point.
receives_invoice_emailsboolean- Whether invoice emails are sent for this subscription. Defaults to true.
referencestring- Your own unique identifier for the subscription.
maxio_subscription_default_payment_profile_changeMake one of the customer's stored payment methods the default for a subscription.WriteChange Subscription Default Payment Profile
Make one of the customer's stored payment methods the default for a subscription. Returns the payment profile that is now the default. Use maxio_subscription_default_payment_profile_change to switch which card or bank account is charged. Use maxio_payment_profiles_list to find the profile id.
Inputs
payment_profile_idintegerrequired- ID of the payment profile to make the default. It must belong to the subscription customer.
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
maxio_subscription_delayed_cancelSchedule a subscription to cancel at the end of its current billing period.WriteSchedule Subscription Cancellation
Schedule a subscription to cancel at the end of its current billing period. Returns a message confirming the delayed cancellation. Use maxio_subscription_delayed_cancel for end-of-period cancellation. Use maxio_subscription_cancel to cancel now, and maxio_subscription_delayed_cancel_stop to undo this.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
cancellation_messagestring- Internal note explaining why the subscription is being canceled.
reason_codestring- Churn reason code to record. Get valid codes from maxio_reason_codes_list.
maxio_subscription_note_createAdd an internal note to a subscription.WriteCreate Subscription Note
Add an internal note to a subscription. Returns the new note with its id. Use maxio_subscription_note_create to record context on an account. Use maxio_subscription_note_update to edit an existing note.
Inputs
bodystringrequired- Text of the note.
stickybooleanrequired- Set to true to pin the note to the top of the subscription page.
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
maxio_subscription_note_updateReplace the text and sticky flag of an existing subscription note.WriteUpdate Subscription Note
Replace the text and sticky flag of an existing subscription note. Returns the updated note. Use maxio_subscription_note_update to edit a note. Use maxio_subscription_note_create to add a new one.
- Idempotent
Inputs
bodystringrequired- Text of the note.
note_idintegerrequired- The Advanced Billing ID of the note.
stickybooleanrequired- Set to true to pin the note to the top of the subscription page.
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
maxio_subscription_pausePut a subscription on hold so it stops billing, optionally until a set date.WritePause Subscription
Put a subscription on hold so it stops billing, optionally until a set date. Returns the subscription in the on_hold state. Use maxio_subscription_pause to stop billing temporarily. Use maxio_subscription_resume to restart billing, or maxio_subscription_cancel to end it.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
automatically_resume_atstring- Date and time (ISO 8601) at which the subscription resumes automatically. Omit to hold indefinitely.
maxio_subscription_payment_update_request_sendEmail the customer a link to update the payment method on a subscription.WriteSend Payment Update Request
Email the customer a link to update the payment method on a subscription. Returns a confirmation on success. Use maxio_subscription_payment_update_request_send when a card has expired or failed. Use maxio_billing_portal_invitation_resend for billing portal access.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
maxio_subscription_prepayment_createRecord a prepayment on a subscription, either received externally or charged to the card on file.WriteCreate Subscription Prepayment
Record a prepayment on a subscription, either received externally or charged to the card on file. Returns the prepayment with id, amount and remaining balance. Use maxio_subscription_prepayment_create to add funds that pay future invoices. Use maxio_subscription_service_credit_issue for a goodwill credit with no payment.
Inputs
amountstringrequired- Prepayment amount as a decimal string, for example 100.00.
detailsstringrequired- Payment details, such as a check number.
memostringrequired- Description of the prepayment.
methodstringrequired- How the prepayment was paid. Use credit_card_on_file to charge the payment method on file; other values record an external payment.one of
checkcashmoney_orderachpaypal_accountcredit_cardcredit_card_on_fileother subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
payment_profile_idinteger- ID of the payment profile to charge when method is credit_card_on_file.
maxio_subscription_previewPreview the charges for a new subscription without creating it.WritePreview Subscription
Preview the charges for a new subscription without creating it. Returns a billing manifest with line items, taxes, discounts and totals for the signup and the next renewal. Use maxio_subscription_preview to quote a price. Use maxio_subscription_create to actually create the subscription.
Inputs
calendar_billingobject- Calendar billing settings, such as snap_day (1 to 28 or end) and calendar_billing_first_charge (prorated, immediate or delayed). Cannot be combined with next_billing_at.
componentsarray- Components to add at signup. Each item has a component_id (ID or handle:<handle>) and, depending on the component kind, allocated_quantity (quantity-based), unit_balance (metered) or enabled (on/off). An item can also set price_point_id.
coupon_codesarray- Coupon codes to apply to the subscription.
currencystring- Currency code for the subscription, for sites with multi-currency enabled.
custom_priceobject- A custom price point unique to this subscription, used instead of product_price_point_id. Needs price_in_cents, interval and interval_unit.
customer_attributesobject- Details for a new customer created with the subscription. Needs first_name, last_name and email; can also hold organization, reference, address fields, phone and metafields.
customer_idinteger- ID of an existing customer to subscribe. Send customer_id, customer_reference or customer_attributes.
customer_referencestring- Reference of an existing customer to subscribe. Send customer_id, customer_reference or customer_attributes.
defer_signupboolean- Set to true to create the subscription in the Awaiting Signup Date state.
expires_atstring- Date and time (ISO 8601) at which the subscription expires.
initial_billing_atstring- Future date and time (ISO 8601) at which the subscription starts. The subscription stays in Awaiting Signup until then.
metafieldsobject- Custom field values as key/value pairs. Unknown keys create new custom fields on the site.
net_termsstring- Number of days after the invoice date that a remittance invoice is due.
next_billing_atstring- Date and time of the next billing (ISO 8601). Used to align imported subscriptions with an existing billing date.
offer_idstring- ID of an offer to apply. Use instead of product and component details.
payment_collection_methodstring- How payments are collected: automatic (charge the payment method on file), remittance (send invoices to be paid manually), or prepaid.one of
automaticremittanceprepaidinvoice payment_profile_idinteger- ID of an existing card or bank account that belongs to the customer, used to pay for this subscription.
product_handlestring- API handle of the product to subscribe to. Send product_handle or product_id.
product_idinteger- ID of the product to subscribe to. Send product_id or product_handle.
product_price_point_handlestring- Handle of a specific price point on the product. Omit to use the product's default price point.
product_price_point_idinteger- ID of a specific price point on the product. Omit to use the product's default price point.
receives_invoice_emailsboolean- Whether invoice emails are sent for this subscription. Defaults to true.
referencestring- Your own unique identifier for the subscription.
skip_billing_manifest_taxesboolean- Set to true to skip tax calculation in the preview.
maxio_subscription_product_migrateMove a subscription to a different product now, with proration for the rest of the period.WriteMigrate Subscription Product
Move a subscription to a different product now, with proration for the rest of the period. Returns the subscription on its new product. Use maxio_subscription_product_migrate for an immediate upgrade or downgrade. Use maxio_subscription_product_migration_preview to see the charges first, or maxio_subscription_update with product_change_delayed for a change at renewal. Needs product_id or product_handle.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
include_couponsboolean- Set to false to drop the coupons on the subscription. Defaults to true.
include_initial_chargeboolean- Set to true to charge the initial charge of the target product. Defaults to false.
include_trialboolean- Set to true to start the trial configured on the target price point. Defaults to false.
preserve_periodboolean- Set to false to reset the billing period to today and charge the full price. Defaults to true, which keeps the period and prorates.
product_handlestring- Handle of the target product. Send product_handle or product_id.
product_idinteger- ID of the target product. Send product_id or product_handle.
product_price_point_handlestring- Handle of a non-default price point on the target product.
product_price_point_idinteger- ID of a non-default price point on the target product.
prorationobject- Proration settings, such as {"upgrade_charge": "prorated", "downgrade_credit": "none", "accrue_charge": false}.
maxio_subscription_product_migration_previewPreview the charges and credits of moving a subscription to a different product, without changing it.WritePreview Subscription Product Migration
Preview the charges and credits of moving a subscription to a different product, without changing it. Returns the prorated adjustment, charge, payment due and credit applied. Use maxio_subscription_product_migration_preview before maxio_subscription_product_migrate. Needs product_id or product_handle.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
include_couponsboolean- Set to false to drop the coupons on the subscription. Defaults to true.
include_initial_chargeboolean- Set to true to charge the initial charge of the target product. Defaults to false.
include_trialboolean- Set to true to start the trial configured on the target price point. Defaults to false.
preserve_periodboolean- Set to false to reset the billing period to today and charge the full price. Defaults to true, which keeps the period and prorates.
product_handlestring- Handle of the target product. Send product_handle or product_id.
product_idinteger- ID of the target product. Send product_id or product_handle.
product_price_point_handlestring- Handle of a non-default price point on the target product.
product_price_point_idinteger- ID of a non-default price point on the target product.
prorationobject- Proration settings, such as {"upgrade_charge": "prorated", "downgrade_credit": "none", "accrue_charge": false}.
proration_datestring- Date and time (ISO 8601) from which proration is calculated in the preview.
maxio_subscription_reactivateReactivate a canceled, expired or trial-ended subscription.WriteReactivate Subscription
Reactivate a canceled, expired or trial-ended subscription. Returns the reactivated subscription with its new state and billing dates. Use maxio_subscription_reactivate for subscriptions that have ended. Use maxio_subscription_resume for a paused (on hold) subscription.
- Idempotent
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
calendar_billingobject- Calendar billing subscriptions only. Object with reactivation_charge: prorated, immediate or delayed.
coupon_codestring- Coupon code to apply on reactivation.
include_trialboolean- Set to true to start a trial on reactivation if the product has one. Defaults to false.
preserve_balanceboolean- Set to true to keep the existing balance instead of clearing it before adding the reactivation charges.
resumeboolean- Set to true to resume the existing billing period if possible instead of starting a new one.
use_credits_and_prepaymentsboolean- Set to true to apply service credits and prepayments on reactivation.
maxio_subscription_renewal_previewPreview a subscription's next renewal, optionally with different component quantities.WritePreview Subscription Renewal
Preview a subscription's next renewal, optionally with different component quantities. Returns the renewal date, line items, subtotal, taxes, discounts, total and the existing balance. Use maxio_subscription_renewal_preview to forecast the next charge. Use maxio_subscription_product_migration_preview to price a product change.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
componentsarray- Optional component quantities to use instead of the current ones. Each item has component_id (ID or handle:<handle>), quantity, and optionally price_point_id.
maxio_subscription_resumeResume billing for a subscription that is on hold.WriteResume Subscription
Resume billing for a subscription that is on hold. Returns the subscription in its resumed state. Use maxio_subscription_resume for paused subscriptions. Use maxio_subscription_reactivate for canceled or expired ones.
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
maxio_subscription_service_credit_issueIssue a service credit to a subscription, which is applied to future invoices.WriteIssue Subscription Service Credit
Issue a service credit to a subscription, which is applied to future invoices. Returns the service credit with amount and new ending balance. Use maxio_subscription_service_credit_issue for goodwill or SLA credits. Use maxio_subscription_prepayment_create when the customer paid in advance.
Inputs
amountstringrequired- Credit amount as a decimal string, for example 10.50.
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
memostring- Reason for the credit.
maxio_subscription_updateUpdate a subscription's product, price point, next billing date, expiration, collection method, net terms or reference.WriteUpdate Subscription
Update a subscription's product, price point, next billing date, expiration, collection method, net terms or reference. Returns the updated subscription. Use maxio_subscription_update for these field changes. Use maxio_subscription_product_migrate for a prorated product change, and maxio_subscription_cancel, maxio_subscription_pause or maxio_subscription_reactivate to change state.
- Idempotent
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
componentsarray- Components whose custom prices should be updated. Each item has component_id and custom_price.
custom_priceobject- A custom price point unique to this subscription. Needs price_in_cents, interval and interval_unit.
expires_atstring- New expiration date and time (ISO 8601).
net_termsstring- Number of days after the invoice date that a remittance invoice is due.
next_billing_atstring- New date and time of the next billing (ISO 8601).
next_product_idstring- ID of the product to switch to at the next renewal. Send an empty string to cancel a pending delayed product change.
next_product_price_point_idstring- ID of the price point to use with next_product_id.
payment_collection_methodstring- How payments are collected: automatic, remittance or prepaid.
product_change_delayedboolean- Set to true to apply the product change at the end of the current period.
product_handlestring- Handle of a different product to switch to. Takes effect at the next renewal when product_change_delayed is true, otherwise immediately without proration.
product_idinteger- ID of a different product to switch to. Same timing rules as product_handle.
product_price_point_handlestring- Handle of a different price point on the current product.
product_price_point_idinteger- ID of a different price point on the current product.
receives_invoice_emailsboolean- Whether invoice emails are sent for this subscription.
referencestring- Your own unique identifier for the subscription.
snap_daystring- Day of the month the subscription renews on: 1 to 28, or end.
maxio_subscription_cancelCancel a subscription immediately, at the end of the current period, or on a scheduled date.DestructiveCancel Subscription
Cancel a subscription immediately, at the end of the current period, or on a scheduled date. Returns the subscription with its new state and cancellation details. Use maxio_subscription_cancel to end a subscription. Use maxio_subscription_delayed_cancel to cancel at period end, and maxio_subscription_pause to stop billing temporarily.
- Idempotent
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
cancel_at_end_of_periodboolean- Set to true to cancel at the end of the current period instead of immediately.
cancellation_messagestring- Internal note explaining why the subscription is being canceled.
reason_codestring- Churn reason code to record. Get valid codes from maxio_reason_codes_list.
refund_prepayment_account_balanceboolean- Prepaid subscriptions only. When true (the default), the remaining prepaid balance is refunded on cancellation.
scheduled_cancellation_atstring- Date and time (ISO 8601) on which to cancel. Not available for prepaid subscriptions.
maxio_subscription_coupon_removeRemove a coupon from a subscription.DestructiveRemove Coupon from Subscription
Remove a coupon from a subscription. Returns a confirmation message. Use maxio_subscription_coupon_remove to take a discount off. Use maxio_subscription_coupons_apply to add one.
- Idempotent
Inputs
coupon_codestringrequired- The code of the coupon to remove from the subscription.
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
maxio_subscription_delayed_cancel_stopRemove a pending end-of-period cancellation so the subscription keeps renewing.DestructiveStop Scheduled Cancellation
Remove a pending end-of-period cancellation so the subscription keeps renewing. Returns a message confirming the delayed cancellation was removed. Use maxio_subscription_delayed_cancel_stop to undo maxio_subscription_delayed_cancel. Use maxio_subscription_reactivate for a subscription that is already canceled.
- Idempotent
Inputs
subscription_idintegerrequired- The numeric Advanced Billing ID of the subscription.
No tools match.
