Team
Shared credential for production and unattended runs.
Connect Maxio with Hookshot™ and your stack
Subscription billing and revenue management platform (formerly Chargify)
Tools and triggers
What Agents can do in Maxio
Available tools and events after Maxio is connected.
-
Allocate Component
Creates 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…
-
Apply Coupons to Subscription
Applies one or more coupons to a subscription. Use when you need to apply promotional discounts or coupon codes to an existing subscription. The coupon must be valid and not expired for the operation to succeed.
-
Archive Component
Archives 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…
-
Archive Component Price Point
Archives 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…
-
Archive Coupon
Archives 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…
-
Archive Offer
Archives 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…
-
Archive Product
Archives 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…
-
Archive Product Price Point
Archives 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…
-
Bulk Create Product Price Points
Creates 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…
-
Bulk Record Events
Tool to record multiple billable events in bulk for a subscription component. Use when you need to log several usage events at once, such as batch processing usage data or recording multiple overage events. Each event…
-
Bulk Reset Subscription Components Price Points
Resets 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…
-
Bulk Update Subscription Component Price Points
Bulk updates component price points for a subscription. Use when you need to update multiple component price points for a subscription. Each component is updated via a separate API call sequentially, so the operation…
-
Cancel Delayed Cancellation
Cancels a scheduled cancellation on a subscription. Use when a user wants to undo a previously scheduled cancellation before it takes effect. This action is reversible only before the scheduled cancellation time passes.
-
Clone Component Price Point
Clones 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…
-
Create Component
Creates 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…
-
Create Component Price Point
Creates 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…
-
Create Coupon Subcodes
Creates 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…
-
Create Customer
Creates 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…
-
Create Invoice
Creates 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…
-
Create Metadata
Creates 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…
-
Create Metafields
Creates 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…
-
Create or Update Coupon Currency Prices
Tool 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…
-
Create Payment Profile
Creates a new payment profile for a customer in Maxio (Chargify). Use when you need to add a new credit card or payment method to a customer's account. The payment profile stores card details securely and returns a…
-
Create Prepaid Usage Component
Creates 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…
-
Create Prepayment
Creates 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…
-
Create Product
Tool 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…
-
Create Product Family
Creates 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…
-
Create Product Price Point
Creates 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…
-
Create Proforma Invoice
Creates a proforma invoice for a subscription. A proforma invoice is a preliminary invoice that shows the expected charges before a final invoice is generated. Use when you need to preview or share expected billing…
-
Create Quantity Based Component
Creates 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…
-
Create Reason Code
Creates 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…
-
Create Signup Proforma Invoice
Creates a proforma invoice for signup preview. A proforma invoice shows the expected charges for a new subscription before it is actually created. Use this action when you need to preview billing amounts for a…
-
Create Subscription
Creates 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…
-
Create Subscription Group with Signup
Creates 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…
-
Create Subscription Note
Creates 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…
-
Create Usage
Records 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…
-
Create Webhook Endpoint
Creates a new webhook endpoint in Maxio Advanced Billing. Use when you need to register a new webhook endpoint to receive event notifications.
-
Deactivate Event Based Component
Deactivates an event-based component on a subscription. Use when you need to disable event-based billing on a subscription, such as pausing usage tracking or stopping billing for a specific component. This action is…
-
Deduct Service Credit
Deducts 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…
-
Delete Coupon Subcode
Deletes 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…
-
Delete Customer
Deletes a customer from Maxio/Chargify. Use this action when you need to permanently remove a customer record. This action is irreversible — once deleted, the customer cannot be recovered. Note: A customer can only be…
-
Delete Prepaid Usage Allocation
Deletes 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…
-
Delete Reason Code
Deletes 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…
-
Delete Subscription Group
Deletes a subscription group and all its associated data. Use this action when you need to permanently remove a subscription group from the system. This action is irreversible — once deleted, the subscription group and…
-
Delete Subscription Note
Deletes 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…
-
Delete Subscription Payment Profile
Removes 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…
-
Delete Unused Payment Profile
Permanently 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…
-
Deliver Proforma Invoice
Delivers 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…
-
Enable Webhooks
Enables 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…
-
Export Invoices
Initiates 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 Proforma Invoices
Initiates 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…
-
Export Subscriptions
Initiates an asynchronous export of subscription data from Maxio/Chargify. Use this action when you need to export bulk subscription data for analysis, backup, or integration with external systems. The export runs…
-
Find Coupon by Code
Finds 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…
-
Get MRR
Returns 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…
-
Initiate Delayed Cancellation
Schedules 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…
-
Issue Advance Invoice
Issues an advance invoice for a subscription. An advance invoice allows billing for upcoming charges in advance of the normal billing cycle. Use this action when you need to immediately bill a customer for expected…
-
Issue Invoice
Issues a draft invoice for payment collection. Once issued, the invoice transitions from 'draft' to 'open' state and is ready to collect payment. Use when you need to finalize a draft invoice and initiate the payment…
-
Issue Service Credit
Issues 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…
-
List All Component Price Points
Lists 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…
-
List All Product Price Points
Lists 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…
-
List Allocations
Lists 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…
-
List Chargify.js Public Keys
Lists 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…
-
List Component Price Points
Lists all price points for a component in Maxio Advanced Billing. Use this action when you need to retrieve all available pricing configurations (such as per-unit, tiered, volume, or stair-step pricing) defined for a…
-
List Components
Returns 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…
-
List Components for Product Family
Lists 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…
-
List Consolidated Invoice Segments
Lists 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…
-
List Coupon Subcodes
Lists 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…
-
List Coupons for Product Family
Lists all coupons within a product family. Use when you need to retrieve all available coupons for a specific product family, such as for displaying coupon options to customers or auditing coupon usage within a product…
-
List Credit Notes
Returns 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…
-
List Customer Subscriptions
Lists 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…
-
List Customers
Returns 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…
-
List Events
Returns 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…
-
List Exported Invoices
Retrieves a list of exported invoices for a specific invoice export batch. Use this action when you need to fetch the rows (invoice data) from a previously initiated invoice export. The batch_id should be obtained from…
-
List Exported Proforma Invoices
Lists exported proforma invoice rows from a previously initiated export batch. Use when you need to retrieve the actual data from a proforma invoices export, such as for analysis, reporting, or importing into another…
-
List Exported Subscriptions
Lists 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…
-
List Invoice Events
Lists all invoice events from Maxio/Chargify with optional filtering. Use this action when you need to retrieve invoice event history, such as tracking invoice status changes (created, paid, voided), monitoring payment…
-
List Invoices
Returns 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…
-
List Metadata for Resource Type
Lists 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…
-
List Metafields
Lists all metafield definitions for a resource type in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all custom field (metafield) definitions configured for a specific resource type such as…
-
List MRR Movements
Returns MRR movement history showing changes in Monthly Recurring Revenue. Use this action when you need to retrieve the history of MRR changes for your Chargify site, such as for financial reporting, churn analysis…
-
List MRR per Subscription
Returns 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…
-
List Offers
Returns 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…
-
List Payment Profiles
Returns a list of payment profiles in Maxio Advanced Billing. Use this action when you need to retrieve all payment profiles (credit cards, bank accounts, or other payment methods) for verification, reporting, or…
-
List Prepayments
Lists all prepayments for a subscription in Maxio Advanced Billing. Use this action when you need to retrieve all prepayments associated with a subscription, including their amounts, payment methods, remaining…
-
List Product Families
Returns 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…
-
List Product Price Points
Lists 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…
-
List Products
Returns 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…
-
List Products for Product Family
Lists all products within a product family in Maxio/Chargify. Use when you need to retrieve all subscription products associated with a specific product family, such as for displaying available plans to customers or…
-
List Proforma Invoices
Lists 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…
-
List Reason Codes
Returns 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…
-
List Service Credits
Lists all service credits for a subscription in Maxio Advanced Billing. Use this action when you need to retrieve all service credits associated with a subscription, including their amounts, memos, and creation…
-
List Subscription Components
Lists 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…
-
List Subscription Components for Site
Lists 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…
-
List Subscription Events
Returns 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…
-
List Subscription Groups
Returns 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…
-
List Subscription Notes
Lists all notes attached to a subscription in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all notes for a specific subscription, such as viewing customer communication history, auditing…
-
List Subscriptions
Returns a list of subscriptions with optional filtering and pagination. Use this action when you need to retrieve all subscriptions from your Chargify/Maxio billing system. Supports pagination and filtering by date…
-
List Usages
Lists all usage records for a component on a subscription. Use this action when you need to retrieve the usage history for a metered or prepaid component attached to a subscription. This is useful for auditing usage…
-
List Webhook Endpoints
Returns 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…
-
List Webhooks
Returns 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…
-
Migrate Subscription Product
Migrates 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…
-
Override Subscription
Overrides 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…
-
Pause Subscription
Pauses 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…
-
Preview Allocations
Previews 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…
-
Preview Customer Information Changes
Previews customer information changes for an invoice. This endpoint shows what the invoice would look like with updated customer information before the changes are actually applied. Use when you need to preview how…
-
Preview Proforma Invoice
Previews 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…
-
Preview Renewal
Previews 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…
-
Preview Signup Proforma Invoice
Previews a proforma invoice for signup. A proforma invoice shows the expected charges for a new subscription before it is actually created. Use this action when you need to preview billing amounts for a potential new…
-
Preview Subscription
Previews 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…
-
Preview Subscription Product Migration
Previews 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…
-
Promote Component Price Point to Default
Promotes 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…
-
Promote Product Price Point to Default
Promotes 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…
-
Reactivate Subscription
Reactivates 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…
-
Reactivate Subscription Group
Reactivates 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…
-
Read Account Balances
Retrieves 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…
-
Read Advance Invoice
Retrieves 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…
-
Read Component
Retrieves 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…
-
Read Component by Handle
Finds 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…
-
Read Component Price Point
Retrieves 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…
-
Read Coupon
Retrieves 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…
-
Read Coupon Usage
Retrieves 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 Credit Note
Retrieves 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…
-
Read Customer
Retrieves 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…
-
Read Customer by Reference
Looks 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…
-
Read Events Count
Returns 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…
-
Read Invoice
Retrieves 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…
-
Read Invoices Export Status
Retrieves 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…
-
Read Offer
Retrieves 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 Payment Profile
Retrieves 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…
-
Read Product
Retrieves 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…
-
Read Product by Handle
Retrieves 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…
-
Read Product Family
Retrieves 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…
-
Read Product Price Point
Retrieves 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…
-
Read Proforma Invoice
Retrieves 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…
-
Read Proforma Invoices Export
Retrieves 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…
-
Read Reason Code
Retrieves 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…
-
Read Site
Retrieves 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…
-
Read Site Stats
Returns 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)…
-
Read Subscription
Retrieves 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…
-
Read Subscription by Reference
Finds 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…
-
Read Subscription Component
Retrieves 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…
-
Read Subscription Note
Retrieves 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…
-
Read Subscriptions Export Status
Retrieves 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…
-
Record Payment for Invoice
Records 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…
-
Refund Invoice
Creates 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…
-
Refund Prepayment
Refunds 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…
-
Remove Coupon From Subscription
Removes an applied coupon from a subscription in Maxio (Chargify) Advanced Billing. Use when you need to remove a promotional discount from an existing subscription and restore regular pricing. This action is…
-
Remove Subscription From Group
Removes 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…
-
Reopen Invoice
Reopens 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…
-
Replay Webhooks
Replays specified webhook deliveries in Maxio Advanced Billing. Use this action when you need to resend webhooks that may have failed, were not delivered, or need to be resent for any reason. Provide a list of webhook…
-
Resume Subscription
Resumes 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…
-
Retry Subscription
Retries 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…
-
Revoke Billing Portal Access
Revokes 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…
-
Send Invoice
Sends 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…
-
Send Request Update Payment Email
Sends 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…
-
Unarchive Component Price Point
Unarchives 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…
-
Unarchive Offer
Unarchives 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 —…
-
Unarchive Product Price Point
Unarchives 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…
-
Update Automatic Subscription Resumption
Updates 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…
-
Update Component
Updates a component's details in Chargify. Use when you need to modify the name, description, pricing scheme, or other attributes of an existing billing component. Only the fields you provide in the request will be…
-
Update Component Price Point
Updates 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…
-
Update Coupon
Updates an existing coupon within a product family in Maxio. Use when you need to modify coupon details such as name, description, code, discount settings, expiration date, or redemption limits. This action supports…
-
Update Coupon Subcodes
Updates 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…
-
Update Customer
Updates 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…
-
Update Invoice Customer Information
Updates 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…
-
Update Payment Profile
Updates 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…
-
Update Prepaid Expiration
Updates 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: -…
-
Update Product
Updates 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…
-
Update Product Family Component
Updates 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…
-
Update Product Price Point
Updates 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…
-
Update Reason Code
Updates 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…
-
Update Subscription
Updates 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…
-
Update Subscription Note
Updates 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…
-
Update Webhook Endpoint
Updates 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…
-
Validate Coupon
Validates a coupon code for a product. Use when you need to verify that a coupon code exists, is active, not expired, and hasn't exceeded its redemption limit before applying it to a subscription. This is a read-only…
-
Void Advance Invoice
Voids 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…
-
Void Invoice
Voids 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…
Setup
Connect Maxio in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
