- Category: commerce
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 177
- Triggers: 0
- Slug:
MAXIO - Version: 20261101_00
Tools
Allocate Component
Allocate Component
MAXIO_ALLOCATE_COMPONENTCreates an allocation for a component on a subscription. Use when you need to allocate quantities of a metered, quantity-based, or on/off component to a subscription. This action is commonly used to: - Add a new component to a subscription (initial allocation) - Upgrade or downgrade the quantity of an existing component - Reactivate a previously cancelled component - Record usage for metered components Note: For metered components, allocating a quantity records usage. For on/off components, use quantity=1 to turn it on or quantity=0 to turn it off.Input Parameters
Output
Apply Coupons to Subscription
Apply Coupons to Subscription
Archive Component
Archive Component
MAXIO_ARCHIVE_COMPONENTArchives a component to prevent new allocations. Use this action when you need to stop allowing new component allocations while keeping existing allocations active. This action is irreversible — once archived, the component cannot be used for new subscriptions, but existing subscriptions with the component will continue to work.Input Parameters
handle:Output
Archive Component Price Point
Archive Component Price Point
MAXIO_ARCHIVE_COMPONENT_PRICE_POINTArchives a component price point, making it inactive. Use when you need to deactivate a price point that is no longer needed but should not be permanently deleted. Archived price points are no longer available for new subscriptions but remain accessible for historical reference. This action is irreversible — once archived, a price point cannot be directly unarchived to its original state (use the unarchive action instead).Input Parameters
Output
Archive Coupon
Archive Coupon
MAXIO_ARCHIVE_COUPONArchives a coupon to prevent new uses. Use this action when you need to deactivate a coupon while preserving its redemption history. This action is irreversible — once archived, the coupon cannot be used for new subscriptions, but existing redemptions remain valid.Input Parameters
Output
Archive Offer
Archive Offer
MAXIO_ARCHIVE_OFFERArchives an offer to prevent new subscriptions from using it. Use this action when you need to deactivate an offer while preserving existing subscriptions. This action is irreversible — once archived, the offer cannot be used for new subscriptions, but existing subscriptions using this offer will continue to function normally.Input Parameters
Output
Archive Product
Archive Product
MAXIO_ARCHIVE_PRODUCTArchives a product to prevent new subscriptions from being created. Use this action when you need to stop accepting new subscriptions for a product while keeping existing subscriptions active. This action is irreversible - once archived, the product cannot be unarchived.Input Parameters
Output
Archive product price point
Archive product price point
MAXIO_ARCHIVE_PRODUCT_PRICE_POINTArchives a product price point by its ID. Use when you need to deactivate and archive a price point that is no longer needed. Archived price points cannot be used for new subscriptions but existing subscriptions will continue to use them. This action is irreversible once completed.Input Parameters
handle:handle:Output
Cancel Delayed Cancellation
Cancel Delayed Cancellation
Clone Component Price Point
Clone Component Price Point
MAXIO_CLONE_COMPONENT_PRICE_POINTClones an existing component price point to create a new one. Use this action when you need to duplicate a price point with all its pricing configuration, optionally providing a new name for the cloned version. The cloned price point will inherit all pricing settings from the source price point including the pricing scheme, prices, and currency configuration.Input Parameters
Output
Bulk Create Product Price Points
Bulk Create Product Price Points
MAXIO_CREATE_BULK_PRODUCT_PRICE_POINTSCreates multiple product price points in a single API call. Use when you need to set up several pricing options for a product at once, such as creating tiered pricing plans (e.g., Basic, Standard, Premium) with different prices, intervals, and trial periods. This is more efficient than creating price points individually. The price_points array accepts price point objects with fields like name, price_in_cents, interval_unit, interval_length, trial configuration, and initial fees.Input Parameters
Output
Create Component
Create Component
MAXIO_CREATE_COMPONENTCreates a new component within a product family in Chargify. Use when you need to add billing components like metered usage, quantity-based pricing, on/off toggles, prepaid usage, or event-based components to a product family. Supports five component types: metered_components (usage-based with unit pricing), quantity_based_components (per-unit pricing), on_off_components (binary add-ons), prepaid_usage_components (credit-based), and event_based_components (event-triggered billing).Input Parameters
Output
Create Component Price Point
Create Component Price Point
MAXIO_CREATE_COMPONENT_PRICE_POINTCreates a price point for a component in Maxio Advanced Billing. Use this action when you need to define a new pricing configuration (such as per-unit, tiered, volume, or stair-step pricing) for a component. This action is irreversible — once created, a price point cannot be deleted via API; it can only be archived.Input Parameters
Output
Create Coupon Subcodes
Create Coupon Subcodes
MAXIO_CREATE_COUPON_SUBCODESCreates multiple subcodes for an existing coupon in Maxio Advanced Billing. Use when you need to add additional coupon codes for tracking, segmentation, or allowing multiple uses of a coupon. Subcodes are tied to the parent coupon and inherit the coupon’s discount rules. Note: Subcodes must be unique across the entire site - they cannot duplicate codes used by other coupons.Input Parameters
Output
Create Customer
Create Customer
MAXIO_CREATE_CUSTOMERCreates a new customer in Maxio/Chargify with the required fields: first_name, last_name, and email. Use this action when you need to add a new customer to your billing system. Optional fields like organization, reference, phone, and address can be included to provide additional customer information.Input Parameters
Output
Create Webhook Endpoint
Create Webhook Endpoint
MAXIO_CREATE_ENDPOINTCreates a new webhook endpoint in Maxio Advanced Billing. Use when you need to register a new webhook endpoint to receive event notifications.Input Parameters
Output
Create Invoice
Create Invoice
MAXIO_CREATE_INVOICECreates a one-time invoice for a subscription with custom line items. Use when you need to bill a customer for a one-time charge or custom amount that is not part of their regular subscription. The invoice can include multiple line items with titles, descriptions, quantities, and prices.Input Parameters
Output
Create Metadata
Create Metadata
MAXIO_CREATE_METADATACreates metadata values for a resource in Maxio/Chargify Advanced Billing. Use this action when you need to attach custom key-value metadata to customers, subscriptions, or sites to store additional information. Note: If metadata with the same name already exists for the resource, this action will update the existing value.Input Parameters
Output
Create Metafields
Create Metafields
MAXIO_CREATE_METAFIELDSCreates metafield definitions for a resource type. Use this action when you need to define custom fields that can be attached to resources like customers, subscriptions, or products. After creating a metafield definition, you can set values for that field on individual resources. The resource_type determines which entity type the metafield applies to. Valid values are: customers, subscriptions, products, or product_families. Use this action when setting up custom data structures for your billing data.Input Parameters
Output
Create or Update Coupon Currency Prices
Create or Update Coupon Currency Prices
MAXIO_CREATE_OR_UPDATE_COUPON_CURRENCY_PRICESTool to create or update currency prices for a coupon in Maxio. Use when you need to set or modify the pricing of a coupon across different currencies. This action is idempotent - calling it will replace all existing currency prices for the coupon with the new values provided.Input Parameters
Output
Create Payment Profile
Create Payment Profile
MAXIO_CREATE_PAYMENT_PROFILECreates a customer payment profile in Maxio (Chargify) using cardholder name, card number and expiration details. The response may include a vault token for future use.Input Parameters
Output
Create Prepaid Usage Component
Create Prepaid Usage Component
MAXIO_CREATE_PREPAID_USAGE_COMPONENTCreates a prepaid usage component for pre-purchased units. Use when you need to create a component that allows customers to prepay for usage-based charges such as SMS credits, API calls, or storage units. The component supports various pricing schemes (per_unit, volume, tiered, stairstep) and optional overage pricing for charges when usage exceeds prepaid amounts. Note: This action creates the component within a product family. Ensure the product_family_id is valid and corresponds to an existing product family in your Chargify/Maxio account.Input Parameters
Output
Create Prepayment
Create Prepayment
MAXIO_CREATE_PREPAYMENTCreates a prepayment for a subscription. Prepayments allow customers to add funds to their account in advance, which are then applied to future invoices. Use this action when a customer wants to prepay for services, make an advance payment, or add funds to their account balance.Input Parameters
Output
Create Product
Create Product
MAXIO_CREATE_PRODUCTTool to create a new product within a product family in Maxio. Use when you need to add a new subscription product to an existing product family for billing purposes. This action is useful for setting up subscription billing products with various pricing configurations including trial periods, initial charges, and billing intervals.Input Parameters
Output
Create Product Family
Create Product Family
MAXIO_CREATE_PRODUCT_FAMILYCreates a new product family in Maxio/Chargify. Product families are top-level containers used to organize products and related components. Use this action when you need to create a new product category or family grouping to organize your subscription products.Input Parameters
Output
Create Product Price Point
Create Product Price Point
MAXIO_CREATE_PRODUCT_PRICE_POINTCreates a price point for a product in Maxio Advanced Billing. Use this action when you need to define a new pricing configuration (such as monthly, annual, or trial pricing) for a product. Price points determine the billing amount, interval, and optional trial periods for subscriptions. The price point must include a name and can optionally include pricing scheme, interval settings, trial configuration, and initial fees.Input Parameters
Output
Create Proforma Invoice
Create Proforma Invoice
Create Quantity Based Component
Create Quantity Based Component
MAXIO_CREATE_QUANTITY_BASED_COMPONENTCreates a quantity-based component for recurring units within a product family. Use when you need to add billing components that charge per unit based on quantity, such as user licenses, team seats, or device slots. Quantity-based components allow customers to purchase a variable number of units (e.g., 5 user licenses) with per-unit pricing that can be tiered.Input Parameters
Output
Create Reason Code
Create Reason Code
MAXIO_CREATE_REASON_CODECreates a new churn reason code in Maxio/Chargify Advanced Billing. Use this action when you need to define a new reason code to categorize why customers cancel or churn from your subscription service. Reason codes are used for reporting and analytics on churn, allowing you to track and understand why customers are leaving.Input Parameters
Output
Create Signup Proforma Invoice
Create Signup Proforma Invoice
Create Subscription
Create Subscription
MAXIO_CREATE_SUBSCRIPTIONCreates a new subscription in Maxio (Chargify) with specified product, customer, and payment details. Use this action when you need to create a new subscription for an existing or new customer. At minimum, either product_handle or product_id is required. Either customer_id or customer attributes (first_name, last_name, email) are required. Payment can be provided via payment_profile_id or direct card entry (card_number, expiration_month, expiration_year).Input Parameters
Output
Create Subscription Group With Signup
Create Subscription Group With Signup
MAXIO_CREATE_SUBSCRIPTION_GROUP_WITH_SIGNUPCreates a subscription group with subscriptions and a shared payer in a single operation. Use this action when you need to create a subscription group that includes multiple subscriptions and a single payer who is responsible for all payments. This is ideal for family plans, corporate accounts, or bundled product offerings where billing should be consolidated under one customer. The action requires a payer (customer who pays) and at least one subscription. Each subscription can have its own product and customer information, but payment is handled by the shared payer.Input Parameters
Output
Create Subscription Note
Create Subscription Note
MAXIO_CREATE_SUBSCRIPTION_NOTECreates a note on a subscription in Maxio/Chargify Advanced Billing. Use this action when you need to add a note or comment to a subscription, such as tracking customer communication, recording support interactions, or documenting billing-related information.Input Parameters
Output
Create Usage
Create Usage
MAXIO_CREATE_USAGERecords usage for a metered component on a subscription. Use this action when you need to track and bill for usage-based consumption such as API calls, storage GB, emails sent, or any other metered usage. This action creates a usage record that will appear on the customer’s invoice. The quantity can be a decimal value for proration purposes. Usage records are useful for: - Tracking overage charges beyond included quantities - Recording metered usage in real-time - Billing for consumption-based servicesInput Parameters
Output
Deactivate Event Based Component
Deactivate Event Based Component
Deduct Service Credit
Deduct Service Credit
MAXIO_DEDUCT_SERVICE_CREDITDeducts from a subscription’s service credit balance. Use this action when you need to reduce or correct a customer’s service credit balance, such as for refunds, billing corrections, or adjusting for erroneous credits. Note: The amount will be deducted from the subscription’s available service credit balance. Ensure the subscription has sufficient credit before deducting.Input Parameters
Output
Delete Coupon Subcode
Delete Coupon Subcode
MAXIO_DELETE_COUPON_SUBCODEDeletes a specific subcode from an existing coupon in Maxio Advanced Billing. Use this action when you need to remove a single subcode from a coupon. This action is irreversible — the subcode will be permanently deleted and cannot be recovered once removed.Input Parameters
Output
Delete Customer
Delete Customer
Delete Prepaid Usage Allocation
Delete Prepaid Usage Allocation
MAXIO_DELETE_PREPAID_USAGE_ALLOCATIONDeletes a prepaid usage allocation from a subscription component. Use this action when you need to remove a specific prepaid allocation that was previously created. This action is irreversible — once deleted, the allocation cannot be recovered. This action is commonly used to: - Remove incorrect or duplicate allocations - Clean up allocations that are no longer needed - Adjust prepaid usage when customers request refunds Note: Deleting an allocation will not automatically adjust billing. You may need to issue a credit or adjust subsequent invoices separately.Input Parameters
Output
Delete Reason Code
Delete Reason Code
MAXIO_DELETE_REASON_CODEDeletes a churn reason code from Maxio/Chargify Advanced Billing. Use this action when you need to permanently remove a reason code from your account. This action is irreversible — once deleted, the reason code cannot be recovered, and any associated reporting data will be affected. Note: This endpoint returns a 404 error if the reason code does not exist.Input Parameters
Output
Delete Subscription Group
Delete Subscription Group
MAXIO_DELETE_SUBSCRIPTION_GROUPDeletes a subscription group by UID in Maxio Advanced Billing. A 404 response is returned as deleted=false rather than an error.Input Parameters
Output
Delete Subscription Note
Delete Subscription Note
MAXIO_DELETE_SUBSCRIPTION_NOTEDeletes a specific note from a subscription in Maxio Advanced Billing. Use this action when you need to remove a single note from a subscription. This action is irreversible — the note will be permanently deleted and cannot be recovered once removed.Input Parameters
Output
Delete Subscription Payment Profile
Delete Subscription Payment Profile
MAXIO_DELETE_SUBSCRIPTION_PAYMENT_PROFILERemoves a payment profile from a subscription in Maxio Advanced Billing. Use when you need to unlink a credit card or payment method from a subscription, for example, when cleaning up obsolete payment profiles or replacing them with new ones. This action is irreversible — once the payment profile is removed from the subscription, it cannot be recovered through this endpoint.Input Parameters
Output
Delete Unused Payment Profile
Delete Unused Payment Profile
MAXIO_DELETE_UNUSED_PAYMENT_PROFILEPermanently deletes an unused payment profile from Maxio/Chargify. Use when you need to remove a payment profile that is no longer associated with any active subscriptions or payment references. This action is irreversible — once deleted, the payment profile cannot be recovered. Note: Only unused payment profiles can be deleted. Attempting to delete a profile that is currently in use (e.g., associated with an active subscription) will result in an error (422 Unprocessable Entity).Input Parameters
Output
Deliver Proforma Invoice
Deliver Proforma Invoice
MAXIO_DELIVER_PROFORMA_INVOICEDelivers a proforma invoice to the customer via email. Use when you need to email a proforma invoice to the customer. By default, the invoice will be sent to the customer on the subscription. Optionally, you can specify custom recipient email addresses to override the defaults. This action sends the proforma invoice immediately and does not wait for payment or create any billing records.Input Parameters
Output
Enable Webhooks
Enable Webhooks
MAXIO_ENABLE_WEBHOOKSEnables or disables webhooks for the Maxio/Chargify site. Use this action when you need to turn webhook notifications on or off. This can be useful during maintenance windows, troubleshooting, or when temporarily pausing webhook deliveries. Note: This action is idempotent — calling it with the same enabled value will not produce any side effects beyond the initial state change.Input Parameters
Output
Export Invoices
Export Invoices
MAXIO_EXPORT_INVOICESInitiates an invoices export job. Use when you need to start an asynchronous export of invoice data from Maxio/Chargify. The export runs as a background job and returns a batch job object that can be used to track the export status and retrieve the exported data. The export job creates a batch that can be queried using the returned batch ID. Check the batch job status by polling until ‘completed’ is ‘true’.Output
Export Proforma Invoices
Export Proforma Invoices
MAXIO_EXPORT_PROFORMA_INVOICESInitiates an asynchronous export of proforma invoices data. Use when you need to export a large set of proforma invoices for analysis, reporting, or backup purposes. The export job runs in the background and returns immediately with a batch job ID. Note: This is a batch export endpoint that creates an async job. The response indicates the job was created (status 201) but does not contain the actual exported data. Poll the batch job status or use a separate download endpoint to retrieve the exported data once the job completes.Output
Export Subscriptions
Export Subscriptions
MAXIO_EXPORT_SUBSCRIPTIONSInitiates an asynchronous export of subscription data from Maxio/Chargify, with optional date and status filters. The response may include export job details, including a download URL.Input Parameters
Output
Get MRR
Get MRR
MAXIO_GET_MRRReturns monthly recurring revenue data for the site. Use this action when you need to retrieve the current MRR (Monthly Recurring Revenue) for your Chargify site, including plan and usage breakouts. This is useful for financial reporting, revenue tracking, and understanding overall subscription revenue metrics. Supports retrieving historical MRR data using the at_time parameter. Note: This is a read-only operation that does not modify any data.Input Parameters
Output
Initiate Delayed Cancellation
Initiate Delayed Cancellation
MAXIO_INITIATE_DELAYED_CANCELLATIONSchedules a subscription for cancellation at the end of its current billing period. Use when a customer requests to cancel their subscription but you want to allow them to continue using the service until the end of the current billing period. This action is reversible — the scheduled cancellation can be cancelled before it takes effect using the Cancel Delayed Cancellation action. Once the scheduled cancellation time passes, the subscription will be cancelled and cannot be automatically reactivated.Input Parameters
Output
Issue Advance Invoice
Issue Advance Invoice
Issue Invoice
Issue Invoice
MAXIO_ISSUE_INVOICEIssues a draft invoice for payment collection. It can optionally capture prepayments or force issuance despite validation warnings; the response may include a payment URL.Input Parameters
Output
Issue Service Credit
Issue Service Credit
MAXIO_ISSUE_SERVICE_CREDITIssues a service credit to a subscription. Service credits are amounts that are added to a subscription’s service credit balance and can be applied toward future invoices. Use this action when you need to compensate a customer, apply promotional credits, or add funds to a subscription’s service credit balance. The credit will increase the subscription’s available service credit balance.Input Parameters
Output
List All Component Price Points
List All Component Price Points
MAXIO_LIST_ALL_COMPONENT_PRICE_POINTSLists all component price points across the site. Use this action when you need to retrieve all price points for billing components, with optional filtering by type, date range, or archived status. Supports pagination via the page and per_page parameters, with a default page size of 25 and maximum of 200. Price points can be filtered by type (catalog, custom, default), date created/updated, specific IDs, or archived status.Input Parameters
Output
List Allocations
List Allocations
MAXIO_LIST_ALLOCATIONSLists all allocations for a component on a subscription. Use this action when you need to retrieve the allocation history for a specific component attached to a subscription. This is useful for auditing usage, tracking upgrades/downgrades, or understanding the current state of a component. The response includes details such as quantity allocated, allocation type, timestamps, and remaining unit balance for each allocation record.Input Parameters
Output
List All Product Price Points
List All Product Price Points
MAXIO_LIST_ALL_PRODUCT_PRICE_POINTSLists all product price points across the site in Maxio Advanced Billing. Use when you need to retrieve all pricing configurations for products, including their billing intervals, trial periods, and initial fees. Supports pagination, sorting, date filtering, and filtering by archived status or product. This action is read-only and returns a paginated list of price points that can be filtered by date ranges, archived status, or specific product.Input Parameters
Output
List Chargify.js Public Keys
List Chargify.js Public Keys
MAXIO_LIST_CHARGIFY_JS_PUBLIC_KEYSLists all public keys for Chargify.js integration in Maxio Advanced Billing. Use when you need to retrieve available public keys for Chargify.js to securely tokenize payment information on the client side. This is a read-only operation that does not modify any data.Output
List Component Price Points
List Component Price Points
List Components
List Components
MAXIO_LIST_COMPONENTSReturns a list of all components across product families in Chargify. Use this action when you need to retrieve all billing components (metered, quantity-based, on/off, prepaid usage, or event-based) from your Chargify site. Supports pagination and filtering by date, IDs, handles, and archival state. This is a read-only operation that does not modify any data.Input Parameters
Output
List Components for Product Family
List Components for Product Family
MAXIO_LIST_COMPONENTS_FOR_PRODUCT_FAMILYLists all components within a product family in Maxio/Chargify. Use when you need to retrieve all billing components (metered, quantity-based, on/off, prepaid usage, or event-based) associated with a specific product family. Supports pagination with optional page and per_page parameters to handle large numbers of components efficiently.Input Parameters
Output
List Consolidated Invoice Segments
List Consolidated Invoice Segments
MAXIO_LIST_CONSOLIDATED_INVOICE_SEGMENTSLists segments of a consolidated invoice. A consolidated invoice combines charges from multiple subscriptions or components into a single invoice. Use when you need to retrieve the individual segments that make up a consolidated invoice, such as to see the breakdown of charges by subscription, component, or product. This is useful for analyzing billing details when customers have multiple subscriptions or services consolidated into one invoice. Note: Not all invoices are consolidated. Only invoices that combine charges from multiple sources will have segments. A regular invoice may have an empty or single-element segments array.Input Parameters
Output
List Coupons for Product Family
List Coupons for Product Family
List Coupon Subcodes
List Coupon Subcodes
MAXIO_LIST_COUPON_SUBCODESLists all subcodes for an existing coupon in Maxio Advanced Billing. Use when you need to retrieve the subcodes associated with a coupon for verification, reporting, or administrative purposes. This is a read-only operation that does not modify any data.Input Parameters
Output
List Credit Notes
List Credit Notes
MAXIO_LIST_CREDIT_NOTESReturns a list of credit notes from Maxio/Chargify. Use this action when you need to retrieve credit notes for a subscription or across your entire site. Credit notes represent credits issued to customers that can be applied to future invoices or refunded. This action supports filtering by subscription, date range, status, and credit note number. Results are paginated using page and per_page parameters. By default, 25 records are returned per page. Note: Credit notes can be in ‘open’ (available to apply), ‘closed’ (fully applied), or ‘voided’ status.Input Parameters
Output
List Customers
List Customers
MAXIO_LIST_CUSTOMERSReturns a list of customers with optional filtering and pagination. Use this action when you need to retrieve customers from your Chargify/Maxio billing system. Supports pagination and filtering by date range, IDs, state, organization, reference, and zip code. This is a read-only operation that does not modify any data.Input Parameters
Output
List Customer Subscriptions
List Customer Subscriptions
MAXIO_LIST_CUSTOMER_SUBSCRIPTIONSLists all subscriptions for a specific customer in Maxio Advanced Billing. Use this action when you need to retrieve all subscriptions associated with a customer, such as for displaying subscription history, auditing purposes, or administrative management. This is a read-only operation that does not modify any data. Results can be filtered by subscription state and paginated using the page and per_page parameters.Input Parameters
Output
List Webhook Endpoints
List Webhook Endpoints
MAXIO_LIST_ENDPOINTSReturns a list of webhook endpoints configured in Maxio Advanced Billing. Use when you need to retrieve all registered webhook endpoints to check their current configuration, monitor which endpoints are active, or verify endpoint IDs. Supports pagination with optional page and per_page parameters to handle large numbers of endpoints efficiently.Input Parameters
Output
List Events
List Events
MAXIO_LIST_EVENTSReturns a list of events for the site in Maxio Advanced Billing. Use this action when you need to retrieve events for audit purposes, monitoring activity, tracking subscription changes, or analyzing payment events. Supports filtering by date range (since/until), event type, and custom filters. Results are paginated using page and per_page parameters for efficient data retrieval.Input Parameters
Output
List Exported Invoices
List Exported Invoices
MAXIO_LIST_EXPORTED_INVOICESRetrieves exported invoice rows for a specified invoice export batch, with pagination. Rows may include line items, payments, credits, taxes, and custom fields.Input Parameters
Output
List Exported Proforma Invoices
List Exported Proforma Invoices
MAXIO_LIST_EXPORTED_PROFORMA_INVOICESLists exported proforma invoice rows from a previously initiated Maxio export batch. Supply the batch ID returned when the export was initiated and use pagination to retrieve rows for reporting, analysis, or import into another system.Input Parameters
Output
List Exported Subscriptions
List Exported Subscriptions
MAXIO_LIST_EXPORTED_SUBSCRIPTIONSLists exported subscriptions from a subscription export batch in Maxio/Chargify. Use this action when you need to retrieve the results of a previously initiated subscription export. The batch_id should be obtained from the export job response. Supports pagination via the page and per_page parameters. Note: This action requires a completed export batch. The batch must have been created using the Export Subscriptions action first.Input Parameters
Output
List Invoice Events
List Invoice Events
List Invoices
List Invoices
MAXIO_LIST_INVOICESReturns a list of invoices with optional filtering and pagination. Use this action when you need to retrieve invoices from Maxio/Chargify, such as for displaying invoice history, generating reports, or processing refunds. Supports filtering by status, date range, customer, subscription, and product. This is a read-only operation that does not modify any data.Input Parameters
Output
List Metadata for Resource Type
List Metadata for Resource Type
MAXIO_LIST_METADATA_FOR_RESOURCE_TYPELists all metadata definitions for a resource type in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all custom metadata field definitions available for a specific resource type (customers, subscriptions, or sites). This is useful for discovering what metadata fields exist before reading or updating their values on specific resources. Note: This endpoint lists the metadata field definitions, not the actual values stored on individual resources. To get values for a specific resource, use the Read Metadata action with the resource_id.Input Parameters
Output
List Metafields
List Metafields
MAXIO_LIST_METAFIELDSLists a page of metafield definitions for a resource type in Maxio/Chargify Advanced Billing. Supports pagination for customers, subscriptions, products, and product families; this is a read-only operation.Input Parameters
Output
List MRR Movements
List MRR Movements
MAXIO_LIST_MRR_MOVEMENTSLists monthly recurring revenue (MRR) movement history for a Maxio/Chargify site, useful for revenue tracking and churn analysis. Filter by date range, subscription, customer, or movement type, and use pagination and sorting to navigate results.Input Parameters
Output
List MRR Per Subscription
List MRR Per Subscription
MAXIO_LIST_MRR_PER_SUBSCRIPTIONReturns MRR broken down by subscription. Use this action when you need to retrieve MRR (Monthly Recurring Revenue) data for your Chargify site, including plan and usage breakouts split per subscription. This is useful for revenue analysis, reporting, and understanding subscription-level revenue metrics. Supports filtering by subscription IDs, retrieving historical MRR data using the at_time parameter, pagination, and sorting direction. Note: This is a read-only operation that does not modify any data.Input Parameters
Output
List Offers
List Offers
MAXIO_LIST_OFFERSReturns a list of all offers in Chargify. Use this action when you need to retrieve all offers from your Chargify site for reporting, analysis, or administrative purposes. Supports pagination and filtering by date, IDs, handles, product ID, subscription ID, offer type, and archival state. This is a read-only operation that does not modify any data.Input Parameters
Output
List Payment Profiles
List Payment Profiles
MAXIO_LIST_PAYMENT_PROFILESLists payment profiles in Maxio Advanced Billing for verification, reporting, or administration. Results can be filtered by customer or vault, sorted, and paginated; related resources can also be requested.Input Parameters
Output
List Prepayments
List Prepayments
List Product Families
List Product Families
MAXIO_LIST_PRODUCT_FAMILIESReturns a list of all product families in Maxio/Chargify. Use this action when you need to retrieve product families from your Chargify/Maxio billing system. Product families are top-level containers used to organize products and related components. Supports pagination and filtering by date range, IDs, and handles. This is a read-only operation that does not modify any data.Input Parameters
Output
List Product Price Points
List Product Price Points
MAXIO_LIST_PRODUCT_PRICE_POINTSLists all price points for a product in Maxio Advanced Billing. Use this action when you need to retrieve all available pricing configurations (such as monthly, annual, or trial pricing) defined for a product. This is helpful for exploring available price points before creating subscriptions, or for auditing pricing configurations across products. Supports pagination and optional filtering by price point status.Input Parameters
Output
List Products
List Products
MAXIO_LIST_PRODUCTSReturns a list of all products from Maxio (Chargify). Use this action when you need to retrieve all subscription products from your Chargify site. Supports pagination and filtering by date, IDs, handles, state, and product family. This is a read-only operation that does not modify any data.Input Parameters
Output
List Products for Product Family
List Products for Product Family
List Proforma Invoices
List Proforma Invoices
MAXIO_LIST_PROFORMA_INVOICESLists all proforma invoices for a specific subscription in Maxio Advanced Billing. Use this action when you need to retrieve the proforma invoice history for a subscription, such as for reviewing billing previews, auditing purposes, or administrative management. This is a read-only operation that does not modify any data. Results can be paginated using the page and per_page parameters.Input Parameters
Output
List Reason Codes
List Reason Codes
MAXIO_LIST_REASON_CODESReturns a list of all churn reason codes in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all reason codes for churn reporting and analytics, such as auditing existing codes, displaying available reasons for cancellation surveys, or managing your churn categorization scheme. Supports pagination to handle accounts with many reason codes. This is a read-only operation that does not modify any data.Input Parameters
Output
List Service Credits
List Service Credits
List Subscription Components
List Subscription Components
MAXIO_LIST_SUBSCRIPTION_COMPONENTSLists all components attached to a subscription in Maxio (Chargify). Use this action when you need to retrieve all billing components (metered, quantity-based, on/off, prepaid usage, or event-based) associated with a specific subscription. This is useful for auditing subscription components, checking quantities allocated, or understanding the component configuration of a subscription. This is a read-only operation that does not modify any data. Results can be paginated using the page and per_page parameters, and filtered by component ID or price point ID.Input Parameters
Output
List Subscription Components For Site
List Subscription Components For Site
MAXIO_LIST_SUBSCRIPTION_COMPONENTS_FOR_SITELists all subscription components for a site. Use this action when you need to retrieve all subscription components across all subscriptions in your Chargify/Maxio site. Supports pagination, sorting, and filtering by date range, subscription IDs, price point IDs, product family IDs, and subscription states. This is a read-only operation that does not modify any data.Input Parameters
Output
List Subscription Events
List Subscription Events
MAXIO_LIST_SUBSCRIPTION_EVENTSReturns a list of events for a specific subscription in Maxio Advanced Billing. Use this action when you need to retrieve all events related to a subscription, such as for audit purposes, tracking subscription changes over time, monitoring payment events, or investigating subscription issues. Supports filtering by event ID range (since_id/until_id) and sorting direction. Results are paginated using page and per_page parameters for efficient data retrieval.Input Parameters
Output
List Subscription Groups
List Subscription Groups
MAXIO_LIST_SUBSCRIPTION_GROUPSReturns a list of subscription groups with optional filtering and pagination. Use this action when you need to retrieve subscription groups from your Chargify/Maxio billing system. Supports pagination and filtering by date range, IDs, state, customer ID, and subscription ID. This is a read-only operation that does not modify any data.Input Parameters
Output
List Subscription Notes
List Subscription Notes
List Subscriptions
List Subscriptions
MAXIO_LIST_SUBSCRIPTIONSLists subscriptions in Chargify/Maxio with pagination and optional filters for date range, state, customer IDs, product IDs, coupon codes, offer ID, trial status, billing interval, and subscription group. This is a read-only operation.Input Parameters
Output
List Usages
List Usages
List Webhooks
List Webhooks
MAXIO_LIST_WEBHOOKSReturns a list of webhooks configured in Maxio Advanced Billing. Use this action when you need to retrieve all webhooks to check their current configuration, monitor which webhooks are active, or verify webhook IDs. Supports pagination and optional filtering by active status. This is a read-only operation that does not modify any data.Input Parameters
Output
Migrate Subscription Product
Migrate Subscription Product
MAXIO_MIGRATE_SUBSCRIPTION_PRODUCTMigrates a subscription to a different product in Maxio/Chargify Advanced Billing. Use when you need to change a subscription’s product (e.g., upgrade, downgrade, or change the subscription plan). This action will update the subscription to point to the new product and adjust billing accordingly based on the product configuration. Note: The migration takes effect immediately and may result in prorated charges or credits depending on the price difference between the products and the current billing cycle.Input Parameters
Output
Override Subscription
Override Subscription
MAXIO_OVERRIDE_SUBSCRIPTIONOverrides cancellation settings of a subscription. Use when you need to update cancellation-related attributes on an existing subscription, such as adding a cancellation message to explain why the subscription was overridden. This action sends an override request to update the subscription’s cancellation settings. The API returns HTTP 204 No Content on success.Input Parameters
Output
Promote Product Price Point to Default
Promote Product Price Point to Default
MAXIO_PATCH_PRODUCT_PRICE_POINT_TO_DEFAULTPromotes a product price point to be the default price point for a product. Use when you need to change which price point is automatically selected for new subscriptions to a product. This action sets the specified price point as the default, meaning it will be automatically selected when creating new subscriptions unless another price point is explicitly specified. This is an idempotent operation - calling it multiple times with the same price point will always result in the same state. Note: Only one price point per product can be the default at a time. Promoting a new price point will automatically demote any existing default price point for that product.Input Parameters
handle:handle:Output
Pause Subscription
Pause Subscription
MAXIO_PAUSE_SUBSCRIPTIONPauses an active subscription in Maxio (Chargify) Advanced Billing. Use when you need to temporarily suspend a subscription without canceling it, such as when a customer requests a pause in service or when there are payment issues that need to be resolved before billing can continue. When paused, the subscription will not be billed and the customer will not have access to the service. The subscription can be resumed using the Resume Subscription action. This action is reversible — resuming the subscription will restore the subscription to its previous state (typically ‘active’).Input Parameters
Output
Preview Allocations
Preview Allocations
MAXIO_PREVIEW_ALLOCATIONSPreviews allocation charges before creating them for subscription components. Use this action when you need to calculate the cost impact of adding, upgrading, downgrading, or removing components from a subscription without actually creating the allocations. This is useful for: - Showing customers a price estimate before confirming changes - Verifying proration calculations - Testing allocation scenarios without affecting actual billing The preview returns estimated charges, including any applicable prorations and taxes. Note: This is a read-only operation that does not create actual allocations.Input Parameters
Output
Preview Customer Information Changes
Preview Customer Information Changes
Preview Proforma Invoice
Preview Proforma Invoice
MAXIO_PREVIEW_PROFORMA_INVOICEPreviews a proforma invoice for a subscription without actually creating it. Use when you need to preview the expected charges and invoice details before committing to create the actual proforma invoice. This is useful for showing customers what they will be charged before finalizing billing. This action does not modify any data - it only generates a preview of what the proforma invoice would look like based on the current subscription state.Input Parameters
Output
Preview Renewal
Preview Renewal
MAXIO_PREVIEW_RENEWALPreviews the next renewal charges for a subscription in Maxio (Chargify). Use this action when you need to show customers what their next billing amount will be at renewal, including any component charges, discounts, and taxes. This is useful for: - Displaying upcoming charges to customers before they occur - Verifying renewal calculations - Showing breakdown of renewal costs - Testing pricing scenarios without affecting actual billing This is a read-only operation that does not modify any data or create charges. The preview is calculated based on the current subscription state and applied coupons.Input Parameters
Output
Preview Signup Proforma Invoice
Preview Signup Proforma Invoice
Preview Subscription
Preview Subscription
MAXIO_PREVIEW_SUBSCRIPTIONPreviews a subscription in Maxio (Chargify) before actual creation to see pricing and details. Use this action when you want to validate subscription parameters, preview costs, or show users what a subscription will look like before confirming the creation. At minimum, either product_handle or product_id is required. Either customer_id or customer_attributes (first_name, last_name, email) are required. Payment can be provided via payment_profile_id, payment_token, or credit_card_attributes. This is a preview-only operation that does not create an actual subscription.Input Parameters
Output
Preview Subscription Product Migration
Preview Subscription Product Migration
MAXIO_PREVIEW_SUBSCRIPTION_PRODUCT_MIGRATIONPreviews a product migration before executing it. Use this action when you need to see what will happen when migrating a subscription to a different product without actually making the change. This allows you to review the price differences, credits, charges, and other migration details before committing to the migration. This is a read-only preview action that does not modify the subscription.Input Parameters
Output
Promote Component Price Point to Default
Promote Component Price Point to Default
MAXIO_PROMOTE_COMPONENT_PRICE_POINT_TO_DEFAULTPromotes a component price point to be the default price point for its component. Use this action when you need to change which price point is used as the default for new subscriptions. This endpoint switches the default price point for the component. The previously default price point will no longer be the default, but it remains available for existing subscriptions and can be promoted back to default if needed.Input Parameters
Output
Reactivate Subscription
Reactivate Subscription
MAXIO_REACTIVATE_SUBSCRIPTIONReactivates a canceled subscription in Maxio (Chargify) Advanced Billing. Use when you need to restore a previously canceled subscription and resume billing for the customer. This action is reversible — you can cancel the subscription again if needed. The subscription will transition from ‘canceled’ state back to ‘active’ state and billing will resume according to the subscription’s billing cycle.Input Parameters
Output
Reactivate Subscription Group
Reactivate Subscription Group
MAXIO_REACTIVATE_SUBSCRIPTION_GROUPReactivates a canceled subscription group in Maxio/Chargify. Use this action when you need to restore a previously canceled subscription group and resume billing for all its associated subscriptions. This action is reversible — you can cancel the group again if needed.Input Parameters
Output
Read Account Balances
Read Account Balances
MAXIO_READ_ACCOUNT_BALANCESRetrieves the account balances for a subscription in Maxio Advanced Billing. Use this action when you need to check the current financial status of a subscription, including any outstanding invoice amounts, service credit balances, and prepayment balances. This is useful for determining if a subscription has sufficient credit for transactions, checking payment status, or auditing account balances. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Advance Invoice
Read Advance Invoice
MAXIO_READ_ADVANCE_INVOICERetrieves an advance invoice for a subscription. An advance invoice shows the charges that will be billed in advance of the normal billing cycle. Use this action when you need to preview or retrieve the advance billing details for a subscription. This is a read-only operation that does not modify any data. Use the IssueAdvanceInvoice action if you need to issue/generate the advance invoice. Note: This action requires a valid subscription_id. The response contains the complete advance invoice details including line items, amounts, and due dates.Input Parameters
Output
Read Component
Read Component
MAXIO_READ_COMPONENTRetrieves details of a specific component within a product family in Maxio/Chargify. Use this action when you need to fetch detailed information about a single billing component (metered, quantity-based, on/off, prepaid usage, or event-based) including its pricing, configuration, and metadata. This is a read-only operation that does not modify any data.Input Parameters
handle:.Output
Read Component by Handle
Read Component by Handle
MAXIO_READ_COMPONENT_BY_HANDLEFinds a component by its unique handle in Maxio/Chargify. Use this action when you need to retrieve a specific billing component using its handle identifier. The handle is a unique string that identifies the component across your Chargify site. Returns the component details including pricing, type, and configuration. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Component Price Point
Read Component Price Point
MAXIO_READ_COMPONENT_PRICE_POINTRetrieves a specific component price point in Maxio Advanced Billing. Use this action when you need to fetch the details of a single price point, including its pricing scheme, price tiers, and configuration settings. This is helpful when you need to inspect a specific price point’s configuration, verify pricing details before creating subscriptions, or retrieve metadata about a price point.Input Parameters
Output
Read Coupon
Read Coupon
MAXIO_READ_COUPONRetrieves details of a specific coupon within a product family. Use this action when you need to fetch the full details of a coupon, such as its discount configuration, redemption status, or to verify coupon properties before applying it to a subscription.Input Parameters
Output
Find Coupon by Code
Find Coupon by Code
MAXIO_READ_COUPON_BY_CODEFinds and retrieves a coupon by its unique code in Maxio Advanced Billing. Use when you need to look up coupon details using the coupon code, such as validating a coupon before applying it, displaying coupon information to customers, or checking coupon status for administrative purposes. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Coupon Usage
Read Coupon Usage
MAXIO_READ_COUPON_USAGERetrieves usage statistics for a coupon. Use when you need to view how many times a coupon has been redeemed, the total discount given, and other usage metrics for a specific coupon within a product family. This is a read-only action that retrieves current statistics from the API.Input Parameters
Output
Read Credit Note
Read Credit Note
MAXIO_READ_CREDIT_NOTERetrieves details of a specific credit note from Maxio/Chargify. Use this action when you need to retrieve detailed information about a specific credit note by its unique identifier (UID). This is a read-only operation that returns the credit note’s line items, taxes, discounts, applications, and refund information. This action is useful for: - Checking the status and remaining balance of a credit note - Viewing line item details of a credit note - Finding which invoices a credit note has been applied to - Examining taxes and discounts on a credit noteInput Parameters
Output
Read Customer
Read Customer
MAXIO_READ_CUSTOMERRetrieves details of a specific customer by their Chargify ID. Use this action when you need to fetch the full details of a customer, such as their contact information, address, tax status, or billing portal status. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Customer By Reference
Read Customer By Reference
MAXIO_READ_CUSTOMER_BY_REFERENCELooks up a customer by their external reference value. Use this action when you have an external reference identifier for a customer and need to retrieve the full customer details from Maxio/Chargify. Returns the customer object if found, or an error if no customer matches the reference. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Events Count
Read Events Count
MAXIO_READ_EVENTS_COUNTReturns a count of events for the site in Maxio Advanced Billing. Use this action when you need to quickly determine the number of events matching specific criteria without retrieving full event details. This is useful for checking event volume, validating data existence, or preparing for paginated queries. Supports filtering by date range (since/until), event type, and custom filters.Input Parameters
Output
Read Invoice
Read Invoice
MAXIO_READ_INVOICERetrieves details of a specific invoice by its unique identifier (UID). Use this action when you need to fetch complete information about a single invoice, such as for displaying invoice details, processing refunds, or verifying payment status. The response includes all line items, taxes, discounts, payments, credits, and customer/seller information associated with the invoice. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Invoices Export Status
Read Invoices Export Status
MAXIO_READ_INVOICES_EXPORTRetrieves the status and details of an invoices export batch job. Use when you need to check whether a previously initiated invoice export has completed and how many rows were exported. This endpoint returns the batch job object including its completion status, creation time, finish time, and the total number of exported invoice rows. The batch_id should be obtained from the response when initiating an invoice export using the Export Invoices action. Note: Once the export is complete (completed=‘true’), you can retrieve the exported invoice data using the List Exported Invoices action with the same batch_id.Input Parameters
Output
Read Offer
Read Offer
MAXIO_READ_OFFERRetrieves details of a specific offer by its ID from Maxio (Chargify). Use this action when you need to fetch full details of a single offer, including product information, discounts, items, and signup pages. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Payment Profile
Read Payment Profile
MAXIO_READ_PAYMENT_PROFILERetrieves details of a specific payment profile in Maxio Advanced Billing. Use this action when you need to fetch details of a payment profile by its ID, such as verifying card information, retrieving vault tokens for payment gateway integrations, or checking the status of a stored payment method. This is a read-only operation that does not modify any data. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Product
Read Product
MAXIO_READ_PRODUCTRetrieves details of a specific product by its ID from Maxio (Chargify). Use this action when you need to fetch full details of a single product, including pricing, billing intervals, trial settings, and product family information. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Product By Handle
Read Product By Handle
MAXIO_READ_PRODUCT_BY_HANDLERetrieves a single product from Maxio (Chargify) by its unique handle. Use this action when you need to fetch a specific product’s details using its handle identifier rather than its numeric ID. This is useful for looking up products when the handle is more readily available or for verifying product details before operations. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Product Family
Read Product Family
MAXIO_READ_PRODUCT_FAMILYRetrieves details of a specific product family in Maxio/Chargify. Use this action when you need to fetch the full details of a product family, such as its name, description, handle, accounting code, or associated signup pages. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Product Price Point
Read Product Price Point
MAXIO_READ_PRODUCT_PRICE_POINTRetrieves a specific product price point in Maxio Advanced Billing. Use this action when you need to fetch the details of a single price point, including its pricing configuration, interval settings, and trial options. This is helpful when you need to inspect a specific price point’s configuration, verify pricing details before creating subscriptions, or retrieve detailed metadata about a price point. Optionally include multi-currency pricing by passing the currency_prices parameter.Input Parameters
Output
Read Proforma Invoice
Read Proforma Invoice
MAXIO_READ_PROFORMA_INVOICERetrieves a specific proforma invoice by its unique identifier. Use this action when you need to fetch detailed information about a single proforma invoice, including line items, amounts, taxes, discounts, customer and seller details, and payment information. This is a read-only operation that does not modify any data. Provide the proforma_invoice_uid to identify the specific invoice to retrieve.Input Parameters
Output
Read Proforma Invoices Export
Read Proforma Invoices Export
MAXIO_READ_PROFORMA_INVOICES_EXPORTRetrieves the status and details of a proforma invoices export batch job. Use when you need to check the status of a previously initiated proforma invoices export, such as to verify completion before fetching the exported rows. Note: This endpoint returns the batch job metadata (status, row count, etc.) but not the actual exported data. Use the List Exported Proforma Invoices action to retrieve the actual rows once the export completes.Input Parameters
Output
Read Reason Code
Read Reason Code
MAXIO_READ_REASON_CODERetrieves a specific churn reason code by its ID from Maxio/Chargify Advanced Billing. Use this action when you need to fetch details of a single reason code, such as when viewing specific churn categorization information, auditing individual reason codes, or retrieving metadata for a known reason code ID. This is a read-only operation that does not modify any data. Note: Returns a 404 error if the reason code does not exist.Input Parameters
Output
Read Site
Read Site
MAXIO_READ_SITERetrieves details about the current Chargify/Maxio site. Use this action when you need to retrieve information about your Chargify site, including site configuration, address, tax settings, and gateway information. This is a read-only operation that does not modify any data. Note: This endpoint returns the site details for the authenticated site based on the credentials provided in the auth configuration.Output
Read Site Stats
Read Site Stats
MAXIO_READ_SITE_STATSReturns site-wide statistics for the Chargify site. Use this action when you need to retrieve aggregate statistics about your Chargify site, including subscription counts by status, Monthly Recurring Revenue (MRR) metrics, and customer statistics. This is useful for dashboard displays, executive reporting, and understanding overall business health at a glance. Note: This is a read-only operation that does not modify any data.Output
Read Subscription
Read Subscription
MAXIO_READ_SUBSCRIPTIONRetrieves details of a specific subscription by its unique identifier (ID). Use this action when you need to fetch complete information about a single subscription, such as for displaying subscription details, checking status, verifying billing information, or managing subscription-related operations. This is a read-only operation that does not modify any data. You can optionally include additional related data like customer, product, or payment_profile using the include parameter.Input Parameters
Output
Read Subscription By Reference
Read Subscription By Reference
MAXIO_READ_SUBSCRIPTION_BY_REFERENCEFinds a subscription by its external reference identifier in Maxio Advanced Billing. Use this action when you need to retrieve a specific subscription using its reference field rather than the internal Chargify subscription ID. This is a read-only operation that does not modify any data. Returns a single subscription object if found, or raises an error if no subscription matches the provided reference.Input Parameters
Output
Read Subscription Component
Read Subscription Component
MAXIO_READ_SUBSCRIPTION_COMPONENTRetrieves details of a component attached to a subscription in Maxio (Chargify). Use this action when you need to fetch detailed information about a specific billing component (metered, quantity-based, on/off, prepaid usage, or event-based) that is associated with a particular subscription. This is useful for checking the current state of a component, including quantity allocated, unit balance, pricing, and configuration details. This is a read-only operation that does not modify any data.Input Parameters
handle:.Output
Read Subscription Note
Read Subscription Note
MAXIO_READ_SUBSCRIPTION_NOTERetrieves a specific note attached to a subscription in Maxio/Chargify Advanced Billing. Use this action when you need to fetch a single note from a subscription, such as retrieving details about a specific customer interaction, viewing a particular support note, or accessing billing-related annotations. This is a read-only operation that does not modify any data.Input Parameters
Output
Read Subscriptions Export Status
Read Subscriptions Export Status
MAXIO_READ_SUBSCRIPTIONS_EXPORTRetrieves the status and details of a subscriptions export batch job. Use this action when you need to check whether a previously initiated subscription export has completed and how many rows were exported. This is useful for monitoring the progress of bulk subscription data exports. This endpoint returns the batch job object including its completion status, creation time, finish time, and the total number of exported subscription rows. The batch_id should be obtained from the response when initiating a subscription export using the Export Subscriptions action. Note: Once the export is complete (completed=‘true’), you can retrieve the exported subscription data using the List Exported Subscriptions action with the same batch_id.Input Parameters
Output
Bulk Record Events
Bulk Record Events
MAXIO_RECORD_BULK_EVENTSRecords up to 1000 billable usage events for a subscription component, each with its own quantity and memo. Events are submitted separately, and the result reports individual successes and failures.Input Parameters
Output
Record Payment for Invoice
Record Payment for Invoice
MAXIO_RECORD_PAYMENT_FOR_INVOICERecords a payment for an invoice. This action can be used to record both full and partial payments against an invoice. Use this action when you need to record a customer payment for an existing invoice. The payment will be applied to the invoice, updating its paid_amount and potentially changing its status to ‘paid’ if the full amount is received. Note: You can specify a payment method explicitly or let the system use the subscription’s default payment profile.Input Parameters
Output
Refund Invoice
Refund Invoice
MAXIO_REFUND_INVOICECreates a refund for a paid invoice. Use this action when you need to process a refund for a customer whose invoice has already been paid. The refund will be recorded against the invoice and a credit note may be generated depending on your settings. This action is irreversible — once a refund is processed, it cannot be automatically reversed. Ensure you have verified the refund amount and reason before executing. Note: The invoice must be in a ‘paid’ state to process a refund.Input Parameters
Output
Refund Prepayment
Refund Prepayment
MAXIO_REFUND_PREPAYMENTRefunds a prepayment made on a subscription. This action is irreversible — once a prepayment is refunded, the refund cannot be undone. Use this action when a customer requests a refund for a prepayment, or when you need to reverse an incorrectly applied prepayment. The refund amount will be returned to the customer according to your refund policy. Note: You must provide either amount (decimal string) or amount_in_cents (integer), but not both. If the prepayment was made through a payment profile (non-external), the external flag should be set appropriately.Input Parameters
amount or amount_in_cents must be provided, but not both.amount or amount_in_cents must be provided, but not both.Output
Remove Coupon from Subscription
Remove Coupon from Subscription
Remove Subscription from Group
Remove Subscription from Group
MAXIO_REMOVE_SUBSCRIPTION_FROM_GROUPRemoves a subscription from its subscription group in Maxio Advanced Billing. Use this action when you need to unlink a subscription from its group, such as when migrating a subscription to operate independently or reorganizing group membership. This action is irreversible — once the subscription is removed from the group, it cannot be recovered through this endpoint.Input Parameters
Output
Reopen Invoice
Reopen Invoice
MAXIO_REOPEN_INVOICEReopens a voided or canceled invoice, changing its status back to open. Use when you need to reinstate an invoice that was previously voided or canceled. This action allows the invoice to be paid or modified again. Only invoices with ‘voided’ or ‘canceled’ status can be reopened. Note: If the invoice had payments applied before being voided/canceled, those payments may need to be reallocated. This action is reversible by voiding or canceling the invoice again.Input Parameters
Output
Replay Webhooks
Replay Webhooks
MAXIO_REPLAY_WEBHOOKSReplays specified webhook deliveries in Maxio Advanced Billing using a list of webhook IDs. Use it to resend webhooks that failed, were not delivered, or need to be resent.Input Parameters
Output
Bulk Reset Subscription Components Price Points
Bulk Reset Subscription Components Price Points
MAXIO_RESET_SUBSCRIPTION_COMPONENTS_PRICE_POINTSResets subscription component price points to their default values. Use when you need to reset custom or overridden price points for subscription components back to their original default configuration. This action can reset all component price points at once, or selectively reset specific components by providing a list of component IDs. If no component IDs are provided, all components will be reset. Note: This action modifies the subscription’s pricing configuration. Once reset, any custom price overrides will be lost.Input Parameters
Output
Resume Subscription
Resume Subscription
MAXIO_RESUME_SUBSCRIPTIONResumes a paused subscription in Maxio (Chargify) Advanced Billing. Use when you need to restore a previously paused subscription and resume billing and service delivery. This action is reversible — you can pause the subscription again if needed. The subscription will transition from ‘paused’ state back to ‘active’ state and billing will resume according to the subscription’s billing cycle.Input Parameters
Output
Retry Subscription
Retry Subscription
MAXIO_RETRY_SUBSCRIPTIONRetries payment for a past due subscription in Maxio (Chargify) Advanced Billing. Use when a subscription has failed payments and you need to manually trigger a retry of the billing attempt. This is useful when the automatic retry attempts have been exhausted or when you want to manually retry outside the standard retry schedule. The subscription should be in a ‘past_due’ state for this action to succeed. If payment succeeds, the subscription will return to an ‘active’ state. If payment fails again, the subscription will remain in ‘past_due’ state.Input Parameters
Output
Revoke Billing Portal Access
Revoke Billing Portal Access
MAXIO_REVOKE_BILLING_PORTAL_ACCESSRevokes billing portal access for a customer. This action invalidates the customer’s current billing portal invitation, preventing them from accessing the self-service portal to view invoices, update payment methods, or manage their subscription. Use this action when a customer requests to have their billing portal access removed, or when access needs to be terminated for security or billing reasons. This action is irreversible — once revoked, the customer will need to be re-invited to regain portal access. Note: The customer must already have portal access enabled. If the customer does not have an active portal invitation, the API may return an appropriate error.Input Parameters
Output
Send Invoice
Send Invoice
MAXIO_SEND_INVOICESends an invoice to the customer via email. Use when you need to email an invoice to the customer. By default, the invoice will be sent to the customer on the subscription. Optionally, you can specify custom recipient email addresses to override the defaults. This action sends the invoice immediately and triggers the delivery process to all specified recipients.Input Parameters
Output
Send Request Update Payment Email
Send Request Update Payment Email
MAXIO_SEND_REQUEST_UPDATE_PAYMENT_EMAILSends an email to the customer requesting they update their payment method. Use when you need to prompt a customer to update their credit card or payment method on file. This is typically used when their current payment method is expiring, has been declined, or needs to be refreshed for any reason. The email will be sent to the billing email address associated with the subscription’s customer account. The customer will receive a link to securely update their payment information through the billing portal. This action does not modify any subscription or payment data directly — it only triggers an email notification to the customer.Input Parameters
Output
Unarchive Component Price Point
Unarchive Component Price Point
MAXIO_UNARCHIVE_COMPONENT_PRICE_POINTUnarchives a component price point, restoring it to active status. Use this action when you need to reactivate an archived price point that was previously deactivated. Once unarchived, the price point becomes available for new subscriptions again. This action is idempotent — unarchiving an already active price point has no effect.Input Parameters
Output
Unarchive Offer
Unarchive Offer
MAXIO_UNARCHIVE_OFFERUnarchives a previously archived offer, making it available for new subscriptions again. Use this action when you need to restore an archived offer that was previously deactivated. This action is idempotent — unarchiving an already active offer has no effect.Input Parameters
Output
Unarchive product price point
Unarchive product price point
MAXIO_UNARCHIVE_PRODUCT_PRICE_POINTUnarchives a product price point by its ID. Use when you need to restore an archived price point that was previously deactivated. Once unarchived, the price point becomes available for new subscriptions again. This action is idempotent — unarchiving an already active price point has no effect.Input Parameters
handle:handle:Output
Update Automatic Subscription Resumption
Update Automatic Subscription Resumption
MAXIO_UPDATE_AUTOMATIC_SUBSCRIPTION_RESUMPTIONUpdates automatic resumption settings for a paused subscription in Maxio (Chargify) Advanced Billing. Use when you need to enable or disable automatic resumption for a subscription that is in a paused (hold) state. This controls whether the subscription will automatically resume billing at the end of the paused period, or remain paused until manually resumed. Note: The subscription must already be in a paused/hold state for this action to take effect.Input Parameters
Output
Update Component
Update Component
Update Component Price Point
Update Component Price Point
MAXIO_UPDATE_COMPONENT_PRICE_POINTUpdates a price point for a component in Maxio Advanced Billing. Use this action when you need to modify the pricing configuration (name, handle, exchange rate settings, or other attributes) of an existing component price point. Only the fields provided in the price_point object will be updated. Fields not included in the request will retain their current values.Input Parameters
Output
Update Coupon
Update Coupon
Update Coupon Subcodes
Update Coupon Subcodes
MAXIO_UPDATE_COUPON_SUBCODESUpdates all subcodes for an existing coupon in Maxio Advanced Billing. Use when you need to replace the entire set of subcodes for a coupon with a new set of codes for tracking, segmentation, or managing coupon usage. This operation overwrites all existing subcodes with the new codes provided. Note: Subcodes must be unique across the entire site - they cannot duplicate codes used by other coupons.Input Parameters
Output
Update Customer
Update Customer
MAXIO_UPDATE_CUSTOMERUpdates an existing customer in Maxio/Chargify. Use this action when you need to modify customer information such as name, email, address, or other attributes. Only the fields provided in the customer object will be updated. Fields not included in the request will retain their current values.Input Parameters
Output
Update Invoice Customer Information
Update Invoice Customer Information
MAXIO_UPDATE_CUSTOMER_INFORMATIONUpdates customer information on an invoice in Maxio/Chargify. Use this action when you need to modify customer details (such as name, email, organization) associated with a specific invoice. Only the fields provided in the customer object will be updated. Note: This action modifies the customer information displayed on the invoice. It does not update the master customer record. For updating the master customer record, use the UpdateCustomer action instead.Input Parameters
Output
Update Webhook Endpoint
Update Webhook Endpoint
MAXIO_UPDATE_ENDPOINTUpdates an existing webhook endpoint in Maxio Advanced Billing. Use when you need to modify an endpoint’s URL or description. This action is idempotent - updating an endpoint with the same values will not change the endpoint. Only the fields provided in the endpoint object will be updated. Fields not included in the request will retain their current values.Input Parameters
Output
Update Payment Profile
Update Payment Profile
MAXIO_UPDATE_PAYMENT_PROFILEUpdates an existing payment profile in Maxio (Chargify). Use when you need to modify an existing payment profile’s details such as card information, billing address, or contact details. At least one field must be provided to update. Note: This action uses PUT which replaces the entire payment profile with the provided data. Only the fields you include in the request will be updated.Input Parameters
Output
Update Prepaid Expiration
Update Prepaid Expiration
MAXIO_UPDATE_PREPAID_EXPIRATIONUpdates the expiration date of a prepaid usage allocation. Use this action when you need to extend or change the expiration date of a prepaid allocation on a subscription component. This action is commonly used to: - Extend the validity period of a prepaid allocation - Correct an incorrect expiration date - Adjust expiration dates for promotional or trial periods Note: This action only modifies the expiration date. It does not affect the quantity or unit balance of the allocation.Input Parameters
Output
Update Product
Update Product
MAXIO_UPDATE_PRODUCTUpdates an existing product in Maxio/Chargify. Use this action when you need to modify product information such as name, description, pricing, billing intervals, or other attributes. Only the fields provided in the product object will be updated. Fields not included in the request will retain their current values.Input Parameters
Output
Update Product Family Component
Update Product Family Component
MAXIO_UPDATE_PRODUCT_FAMILY_COMPONENTUpdates a component within its product family in Maxio/Chargify. Use this action when you need to modify the configuration of an existing billing component (metered, quantity-based, on/off, prepaid usage, or event-based) within a product family. Only the fields provided in the component object will be updated. Fields not included in the request will retain their current values. The response returns the full updated component object. This is an idempotent operation — calling it multiple times with the same parameters will produce the same result.Input Parameters
handle:.Output
Update Product Price Point
Update Product Price Point
MAXIO_UPDATE_PRODUCT_PRICE_POINTUpdates a product price point in Maxio Advanced Billing. Use when you need to modify an existing pricing configuration for a product, such as changing the name, price, billing interval, trial period, or any other price point attribute. Only include the fields you want to change - all fields in the price_point object are optional for updates.Input Parameters
Output
Update Reason Code
Update Reason Code
MAXIO_UPDATE_REASON_CODEUpdates an existing churn reason code in Maxio/Chargify Advanced Billing. Use this action when you need to modify an existing reason code to update its code identifier, description, or position in lists. This is commonly used to keep reason codes up-to-date as your churn categorization scheme evolves. Only the fields provided in the reason_code object will be updated. Fields not included in the request will retain their current values.Input Parameters
Output
Update Subscription
Update Subscription
MAXIO_UPDATE_SUBSCRIPTIONUpdates an existing subscription’s details in Maxio/Chargify. Use this action when you need to modify subscription attributes such as product, payment method, billing settings, or apply coupons. Only the fields provided in the subscription object will be updated. Fields not included in the request will retain their current values. This action is commonly used to change products, update payment profiles, modify billing settings, or apply promotional codes.Input Parameters
Output
Bulk Update Subscription Component Price Points
Bulk Update Subscription Component Price Points
MAXIO_UPDATE_SUBSCRIPTION_COMPONENTS_PRICE_POINTSBulk updates component price points for a subscription through sequential individual requests. The operation is not atomic: it stops on a failed update, and earlier successful updates are not rolled back.Input Parameters
Output
Update Subscription Note
Update Subscription Note
MAXIO_UPDATE_SUBSCRIPTION_NOTEUpdates an existing note on a subscription in Maxio/Chargify Advanced Billing. Use this action when you need to modify the content or sticky status of an existing subscription note, such as updating customer communication records, revising support notes, or changing the visibility of a note. Note: At least one of body or sticky must be provided to update the note.Input Parameters
Output
Validate Coupon
Validate Coupon
Void Advance Invoice
Void Advance Invoice
MAXIO_VOID_ADVANCE_INVOICEVoids an advance invoice for a subscription. This cancels the advance billing charges and prevents them from being processed. Use this action when you need to cancel or reverse an advance invoice before it is paid. This action is irreversible once executed — the advance invoice will be marked as voided and cannot be reinstated. Use with caution and ensure you have verified the correct invoice_uid before proceeding. Note: The invoice_uid is required to specify which advance invoice to void. Only advance invoices in ‘open’ or ‘pending’ state can be voided.Input Parameters
Output
Void Invoice
Void Invoice
MAXIO_VOID_INVOICEVoids an open invoice to stop future collection. Once voided, the invoice transitions from ‘open’ (or ‘draft’) to ‘voided’ state and will not be collected. Use when you need to cancel an invoice before payment is processed, such as when a customer cancels before payment is due, there’s a billing error, or the service was not provided. This action is irreversible — once voided, the invoice cannot be restored to its previous state. Note: Only invoices in ‘draft’ or ‘open’ state can be voided. Voiding stops all future collection attempts and marks the invoice as permanently canceled.