Skip to main content
Maxio logo
  • Category: commerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 177
  • Triggers: 0
  • Slug: MAXIO
  • Version: 20261101_00

Tools

Slug: 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

string
An optional memo or note describing the allocation
integer
required
The quantity of the component to allocate. Must be a non-negative integer. For on/off components, use quantity=1 to turn it on or quantity=0 to turn it off.
string
The date on which to begin charging for the allocation. Only applicable for components with ‘immediate’ billing timing. Format: YYYY-MM-DD.
integer
required
The component ID to allocate. This is the numeric ID of the component.
string
The date on which to calculate prorated component costs. If not provided, defaults to the current date/time. Format: YYYY-MM-DD or ISO 8601 datetime.
string ("initial" | "upgrade" | "downgrade" | "cancellation" | "reactivation")
The type of allocation action. Use ‘initial’ for new allocations, ‘upgrade’ or ‘downgrade’ for quantity changes, ‘cancellation’ when ending the component, or ‘reactivation’ when resuming.
integer
required
The subscription ID to allocate the component on. This is the numeric ID of the subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_APPLY_COUPONS_TO_SUBSCRIPTIONApplies a coupon code to an existing subscription to provide a promotional discount. One coupon code is submitted per request.

Input Parameters

string
required
The coupon code to apply to the subscription
integer
required
The ID of the subscription to apply the coupon to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Either the Chargify id of the component or the handle for the component prefixed with handle:
integer
required
The Chargify id of the product family to which the component belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the component to which the price point belongs
integer
required
The Chargify id of the price point to archive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the coupon to archive
integer
required
The Chargify id of the product family to which the coupon belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the offer to archive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the product to archive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The id or handle of the product. When using the handle, it must be prefixed with handle:
string
required
The id or handle of the price point. When using the handle, it must be prefixed with handle:

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_CANCEL_DELAYED_CANCELLATIONCancels 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.

Input Parameters

integer
required
The ID of the subscription for which to cancel the delayed cancellation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Name for the cloned price point. If not provided, the API will generate a default name.
integer
required
The ID of the component that owns the price point to clone.
integer
required
The ID of the price point to clone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID or handle of the product to create price points for. When using handle, prefix with ‘handle:’.
array
required
Array of price point objects to create. Each price point must have a unique name within the product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("metered_components" | "quantity_based_components" | "on_off_components" | "prepaid_usage_components" | "event_based_components")
required
The component kind. Use the plural form: metered_components, quantity_based_components, on_off_components, prepaid_usage_components, or event_based_components.
object
On/off component configuration.
object
Metered component configuration.
integer
required
The Chargify id of the product family to which the component belongs.
object
Event-based component configuration.
object
Prepaid usage component configuration.
object
Quantity-based component configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The price point object containing the pricing configuration. Must include name and pricing_scheme at minimum. The prices array is required for all pricing schemes.
integer
required
The ID of the component for which to create the price point.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of subcode strings to create for the coupon. Each code must be unique and not already exist on the coupon. Maximum of 1000 codes per request.
integer
required
The Chargify ID of the coupon to add subcodes to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Customer’s email address
string
Customer’s phone number
string
Customer’s preferred locale (e.g., en-US, fr-FR)
object
Address information for the customer.
string
Comma-separated list of additional email addresses to CC on billing notifications
string
required
Customer’s last name
string
Unique external identifier for the customer (e.g., from your internal system)
string
required
Customer’s first name
string
Organization or company name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The URL that will receive webhook event notifications. Must be a valid HTTPS URL accessible from the internet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of line items to include on the invoice.
string
required
The ID of the subscription to create the invoice for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of metadata key-value pairs to create. Each item requires a ‘name’ field and an optional ‘value’ field. To remove a metadata field, set the value to null.
integer
required
The unique identifier of the resource to attach metadata to
string ("customers" | "subscriptions" | "sites")
required
The type of resource to attach metadata to. Common types include: customers, subscriptions, sites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of metafield definitions to create. Each defines a custom field with its name, data type, and options.
string
required
The type of resource to create metafields for. Valid values: customers, subscriptions, products, or product_families.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Advanced Billing id of the coupon
array
required
Array of currency price objects to set for the coupon

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Card Verification Value (CVV/CVC) - the 3 or 4 digit security code on the back of the card.
string
Company name associated with the payment profile.
string
required
Last name of the cardholder as it appears on the credit card.
string
required
First name of the cardholder as it appears on the credit card.
string
ZIP or postal code for the billing address.
string
required
Credit card number (full 16-digit card number). The card number will be tokenized by the payment gateway.
integer
required
The unique identifier of the customer to associate with this payment profile. Must be a valid customer ID.
string
Token representing a payment method already stored in the payment vault (e.g., from a previous transaction). If provided, other card details may not be needed.
string
City for the billing address.
string
State or province for the billing address.
string
The vault where the card data is already stored. Examples: ‘stripe’, ‘braintree’, ‘authorizenet’.
string
A tokenized payment method token from a payment gateway.
boolean
Whether to run a $0 authorization to validate the card. Defaults to true if not specified.
string
Street address for the billing address.
string
Country code (2-letter ISO code) for the billing address.
integer
required
Expiration year of the credit card (4-digit year).
integer
required
Expiration month of the credit card (1-12).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the prepaid usage component
string
A unique identifier for the component within the product family (used for API references). If not provided, will be auto-generated from the name.
array
required
Array of price tiers. For ‘per_unit’, include one entry with starting_quantity=1. For ‘volume’ or ‘tiered’, include multiple tiers with different starting quantities.
string
The tax code for the component (used for tax calculations)
string
required
The name of the unit for this component (e.g., ‘credits’, ‘calls’, ‘GB’)
string
A description of what this prepaid usage component represents
string ("per_unit" | "volume" | "tiered" | "stairstep")
required
The pricing scheme for the component. Must be ‘per_unit’, ‘volume’, ‘tiered’, or ‘stairstep’.
string
Upgrade charge option when upgrading mid-period: ‘prorated’ (default), ‘full’, or ‘immediate’
string
An accounting code for the component (used for invoicing and reporting)
object
Pricing configuration for usage that exceeds prepaid amounts.
string
Credit option when downgrading mid-period: ‘prorated’ (default), ‘full’, or ‘none’
string
Revenue recognition schedule for the component
integer
required
The ID of the product family to create the component under
boolean
Whether to use the site’s exchange rate for multi-currency pricing. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A description or note for the prepayment that will appear on the invoice
string
required
The amount of the prepayment as a decimal string (e.g., ‘10.00’). This represents the total amount to be charged.
string ("credit_card" | "ach" | "paypal" | "wire_transfer" | "check")
required
The payment method to use for the prepayment. Must be one of: credit_card, ach, paypal, wire_transfer, or check.
string
Additional details or notes about the prepayment. These details will be recorded but not shown on the invoice.
integer
required
The Chargify subscription ID for which to create the prepayment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The product name. This is required and must be unique within the product family.
boolean
Whether the product is active and available for subscription. Inactive products cannot be subscribed to.
string
A unique identifier for the product. If not provided, a handle will be auto-generated from the name. Must be unique across the site.
integer
required
The number of interval units between each billing date. For example, interval=1 with interval_unit=‘month’ means monthly billing.
string
A tax code for the product to be used in tax calculations. Used by Avalara and other tax integrations.
string
A detailed description of the product. This value is used for SEO and display purposes.
string ("day" | "month" | "year" | "week")
required
The unit of time for the billing interval. Valid values: ‘day’, ‘month’, ‘year’, ‘week’.
integer
required
The price in cents. Must be a positive integer representing the amount to charge per billing interval.
integer
The number of trial intervals before regular billing begins. Should be used with trial_interval_unit.
string
An accounting code for the product to be used in financial reporting and integrations.
integer
required
The unique identifier of the product family to which the product will belong.
integer
The number of intervals after which the subscription expires. If not provided, the subscription continues indefinitely.
boolean
Whether to request credit card information at checkout. Useful for forcing card collection even when the product has no upfront cost.
boolean
Whether a credit card is required to start the subscription. Defaults to false if not specified.
string ("day" | "month" | "year" | "week")
Unit of time for the billing interval.
integer
The trial price in cents. If provided, the customer will be charged this amount during the trial period instead of the regular price.
integer
A one-time upfront charge in cents that occurs at subscription creation. Useful for activation fees.
string ("day" | "month" | "year" | "week")
Unit of time for the billing interval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the product family. This field is required.
string
A unique identifier used to reference the product family in the API. Must be unique across all product families in the site. If not provided, will be auto-generated from the name.
string
A text description of the product family
string
A code used with your accounting system to track revenue

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID or handle of the product to create a price point for. When using handle, prefix with ‘handle:’.
object
required
The price point object containing the pricing configuration. Must include name at minimum.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_CREATE_PROFORMA_INVOICECreates a proforma invoice for a subscription to preview or share expected billing amounts before a final invoice is generated. The request has an empty body, and the response can include line items and amounts.

Input Parameters

integer
required
The ID of the subscription for which to create a proforma invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the product family to which the component belongs.
object
required
Configuration for the quantity-based component.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A unique identifier code for the reason code. This is the value that will be used when reporting churn reasons.
integer
The order position of the reason code in lists. Must be a positive integer.
string
A human-readable description explaining the reason code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_CREATE_SIGNUP_PROFORMA_INVOICECreates a proforma invoice to preview expected charges for a new subscription before signup. Requires a product ID and customer attributes including first name, last name, and email; the response can include line items and amounts.

Input Parameters

integer
required
The ID of the product/pricing plan to subscribe to
object
required
Customer information for the signup preview

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Card Verification Value (CVV/CVC)
string
Comma-separated list of fields to group the subscription with others
string
Last name on the credit card
integer
Number of days until the subscription invoice is due (0 = immediate)
string
Purchase order number for the subscription
string
Date/time to end the trial period (ISO 8601 format, e.g., ‘2024-12-01T00:00:00Z’)
array
Component allocation settings as list of component configurations
string
First name on the credit card
integer
The ID of the product (required if product_handle not provided)
string
Billing ZIP or postal code
string
Full credit card number (will be tokenized)
integer
The ID of an existing customer to associate with this subscription (required if not providing customer attributes)
string
Token from a payment vault for an already stored payment method
string
Billing city
array
List of coupon codes to apply to the subscription
string
Billing state or province
string
The vault where the card is stored (e.g., ‘stripe’, ‘braintree’, ‘authorizenet’)
array
Custom field values as list of name/value objects
string
A tokenized payment method from a payment gateway (e.g., ‘tok_visa’)
string
Referral code to apply to the subscription
string
Customer’s email address (use when creating customer inline)
string
Customer’s phone number
string
The handle of the product (required if product_id not provided)
string
Billing street address
string
Billing country code (2-letter ISO code)
integer
Expiration year of the credit card (4-digit year)
integer
Expiration month of the credit card (1-12)
string
Customer’s last name (use when creating customer inline)
string
External reference for customer
integer
The ID of an existing payment profile to use for billing
string
Customer’s first name (use when creating customer inline)
string
Customer’s organization (use when creating customer inline)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
ID of an existing customer to use as the payer. If provided, payer_attributes can be omitted or will be ignored.
array
required
List of subscriptions to create in the group. At least one subscription is required.
object
Customer attributes for subscription creation.
integer
ID of an existing payment profile belonging to the payer. Required for subscription group signup.
string
When to charge the payment method for the group. One of: ‘at_signup’, ‘at_review’, ‘immediately’, ‘end_of_period’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The content/body of the note to be created
string
Timestamp for when the note was created (UTC, format: YYYY-MM-DDTHH:MM:SSZ). If not provided, current time will be used.
integer
required
The Chargify subscription ID to attach the note to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 services

Input Parameters

string
A memo describing the usage. This will appear on the invoice line item.
number
required
The quantity of usage to record. Can be a decimal value for proration.
string
The time the usage was recorded, in ISO 8601 format (e.g., ‘2024-01-15T10:30:00Z’). Defaults to the current time if not specified.
integer
required
The numeric ID of the metered component to record usage against.
integer
required
The numeric ID of the subscription to record usage for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_DEACTIVATE_EVENT_BASED_COMPONENTRequests deactivation of an event-based component on a subscription using the subscription and component IDs. An empty result can also follow a 403 response, so it does not confirm that the component was deactivated.

Input Parameters

integer
required
The Chargify id of the component
integer
required
The Chargify id of the subscription

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
An optional description or note for the service credit deduction. This will appear in the transaction history.
string
required
The amount to deduct from the subscription’s service credit balance as a decimal string (e.g., ‘10.00’). Must be a positive value.
integer
required
The Chargify subscription ID from which to deduct the service credit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The subcode string to delete from the coupon
integer
required
The Chargify id of the coupon to which the subcode belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_DELETE_CUSTOMERDeletes a customer from Maxio/Chargify using a customer ID. The action may return a JSON error response without raising an error, so inspect the result to confirm deletion.

Input Parameters

integer
required
The Chargify id of the customer to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the component. This is the numeric ID of the component.
integer
required
The Chargify id of the allocation. This is the numeric ID of the allocation to delete.
integer
required
The Chargify id of the subscription. This is the numeric ID of the subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the reason code to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (uid) of the subscription group to delete. This is the uid from the subscription group object, not the numeric id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the note to delete
integer
required
The Chargify id of the subscription

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the subscription to which the payment profile belongs
integer
required
The Chargify id of the payment profile to remove from the subscription

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the payment profile to delete. Only unused payment profiles can be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional list of email addresses to send the proforma invoice to. If not provided, the default recipient(s) from the invoice will be used.
array
Optional list of email addresses to CC on the proforma invoice delivery
array
Optional list of email addresses to BCC on the proforma invoice delivery
string
required
The unique identifier of the proforma invoice to deliver

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
When set to true, webhooks will be enabled and events will be sent to registered endpoints. When set to false, webhooks will be disabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination when export is paginated
string
Filter by subscription status. One of: active, canceled, trial, paused, expired, pending
string
Filter subscriptions modified on or before this date (YYYY-MM-DD format)
integer
Number of records per page (1-200, default 25)
string
The subscription date field to filter by. One of: created_at, updated_at, activated_at, canceled_at
string
Filter subscriptions modified on or after this date (YYYY-MM-DD format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Submit a timestamp in ISO8601 format to request MRR for a historic time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The numeric ID of the subscription to schedule for cancellation at end of period

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_ISSUE_ADVANCE_INVOICEIssues an advance invoice for a subscription to bill upcoming charges ahead of the normal billing cycle. The response may include invoice details such as line items, amounts, and due dates.

Input Parameters

integer
required
The ID of the subscription for which to issue an advance invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
When set to true, the invoice will be issued even if there are validation warnings. Use with caution. Defaults to false.
string
required
The unique identifier of the invoice to issue
boolean
When set to true, any available prepayments on the subscription will be automatically applied to the invoice at issue time. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
An optional description or note for the service credit. This will appear in the transaction history.
string
required
The amount to credit to the subscription’s service credit balance as a decimal string (e.g., ‘10.00’). Must be a positive value.
integer
required
The Chargify subscription ID to which to issue the service credit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number of results to fetch. By default, the first page of results is displayed. Use this parameter to navigate through pages of results.
string
Include additional data in the response. For example, ‘currency_prices’ to include currency-specific pricing.
integer
The number of records to fetch per request. Default is 20, maximum is 200. Values over 200 will be changed to 200.
string ("asc" | "desc")
Direction for sorting results.
string
Filter price points by specific IDs. Provide as comma-separated values (e.g., ‘1,2,3’).
string ("catalog" | "custom" | "default")
Type of component price point.
string
Filter price points with timestamp up to and including this date. Format: YYYY-MM-DD. Uses site’s time zone.
string ("created_at" | "updated_at")
Date field to filter on.
string
Filter price points with timestamp on or after this date. Format: YYYY-MM-DD. Uses site’s time zone.
string ("null" | "not_null")
Filter for archived price points.
string
Filter price points with timestamp up to and including this datetime. Format: YYYY-MM-DD HH:MM:SS. Can include timezone.
string
Filter price points with timestamp on or after this datetime. Format: YYYY-MM-DD HH:MM:SS. Can include timezone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination (default 1).
integer
Number of allocations to return per page (1-200, default 25).
integer
required
The numeric ID of the component to list allocations for.
integer
required
The numeric ID of the subscription to list allocations for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve. Defaults to 1.
string
The field to sort results by. Valid values include ‘created_at’, ‘updated_at’, ‘name’, or ‘id’.
string
Filter records to include only those with a date (specified by date_field) on or before this date. Format: YYYY-MM-DD or ISO 8601.
integer
The number of records to return per page. Defaults to 25. Maximum is 200.
string
The sort direction for results. Valid values are ‘asc’ for ascending or ‘desc’ for descending.
string
The date field to use for filtering when start_date or end_date is provided. Valid values are ‘created_at’ or ‘updated_at’.
string
Filter records to include only those with a date (specified by date_field) on or after this date. Format: YYYY-MM-DD or ISO 8601.
boolean
Filter results to include only archived (true), non-archived (false), or all (null) price points.
string
Filter results to only include price points belonging to a specific product. Accepts product ID or handle prefixed with ‘handle:’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_LIST_COMPONENT_PRICE_POINTSLists a page of price points for a component in Maxio Advanced Billing, including available pricing configurations such as per-unit, tiered, volume, or stair-step pricing. Supports pagination for exploring or auditing component pricing.

Input Parameters

integer
Page number for pagination. Defaults to 1 if not specified.
integer
Number of price points to return per page (1-200). Defaults to 25.
integer
required
The ID of the component for which to list price points.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination.
integer
The number of records to return per page (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
array
Filter by component IDs.
string
Filter by component handle (exact match).
array
Filter by multiple component handles.
string
Filter components created/updated on or before this date (YYYY-MM-DD format).
string
The date field to filter by. One of: created_at, updated_at.
string
Filter components created/updated on or after this date (YYYY-MM-DD format).
string
Filter by archival state. One of: not_archived, archived, both.
integer
Filter by product family ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number for pagination (1-indexed).
integer
Number of records to return per page (1-200, default 25).
integer
required
The Chargify id of the product family whose components to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the consolidated invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_LIST_COUPONS_FOR_PRODUCT_FAMILYLists 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 family.

Input Parameters

integer
required
The Chargify id of the product family whose coupons to list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify ID of the coupon whose subcodes should be listed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve. Pages start at 1. Use together with per_page for pagination.
string ("open" | "closed" | "voided")
Filter credit notes by their status. ‘open’ returns credit notes available for application, ‘closed’ returns applied credit notes, ‘voided’ returns voided credit notes.
string
Filter credit notes created on or before this date. Format: YYYY-MM-DD
integer
The number of records per page. Defaults to 25 if not specified. Maximum value is 200.
string ("created_at" | "credit_note_date")
The field to use for date filtering. Use ‘created_at’ to filter by when the credit note was created, or ‘credit_note_date’ to filter by the credit note date.
string
Filter credit notes created on or after this date. Format: YYYY-MM-DD
string
Filter credit notes created at or before this datetime. Format: ISO 8601 datetime (e.g., ‘2024-12-31T23:59:59Z’)
string
Filter credit notes created at or after this datetime. Format: ISO 8601 datetime (e.g., ‘2024-01-01T00:00:00Z’)
integer
Filter credit notes to a specific subscription ID. The subscription must belong to the authenticated site.
string
Search for a specific credit note by its credit note number. Exact match or partial match depending on API behavior.
boolean
Include credit note components in the response. When true, returns line item details for each credit note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination.
integer
The number of records to return per page (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
array
Filter by customer IDs.
string
Filter by postal/zip code.
string
Filter by customer state. One of: active, canceled.
string
Filter customers created/updated on or before this date (YYYY-MM-DD format).
string
Filter by customer reference (exact match).
string
The date field to filter by. One of: created_at, updated_at.
string
Filter customers created/updated on or after this date (YYYY-MM-DD format).
string
Filter by organization name (exact match or partial match depending on API behavior).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve (default: 1)
string ("active" | "canceled" | "trialing" | "paused" | "past_due" | "trial_ended" | "completed" | "suspended" | "expired" | "failed" | "pending" | "any")
Filter by subscription state
string
Comma-separated list of related resources to include (e.g., ‘customer,product’)
integer
The number of results per page (default: 25, max: 200)
integer
required
The Chargify customer ID whose subscriptions to list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number for pagination (1-indexed).
integer
Number of records to return per page (1-200, default 25).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number for pagination (1-indexed).
string
Filter events created on or after this datetime (ISO 8601 format, e.g., ‘2024-01-01T00:00:00Z’).
string
Filter events created on or before this datetime (ISO 8601 format, e.g., ‘2024-12-31T23:59:59Z’).
string
A filter key to narrow down results. Format depends on the filter type (e.g., ‘subscription_id=12345’).
integer
Number of records to return per page (1-200, default 25).
string
Filter by event type. Common event types include: subscription_created, subscription_updated, subscription_canceled, subscription_activated, subscription_paused, payment_success, payment_failed, invoice_created, invoice_paid, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Use this to navigate through pages of results. If there are no results, an empty result set will be returned.
string
required
The unique identifier of the invoice export batch. This is the ID returned when initiating an invoice export.
integer
Number of records to fetch per page. Default is 100. Maximum allowed value is 10000; any value over 10000 will be changed to 10000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number of results to fetch. Use for pagination when results span multiple pages.
string
required
The unique identifier of the export batch job (returned when initiating the export)
integer
Number of records to fetch per page. Default is 100. Maximum allowed value is 10000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. If there are no results, an empty result set will be returned.
string
required
The batch ID from the export job. This is the subscription_id returned when creating an export.
integer
Number of records to fetch per page. Default is 100. Maximum is 10000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_LIST_INVOICE_EVENTSLists Maxio/Chargify invoice events for reviewing invoice history, payment activity, or billing events. Filter by date range and paginate results; the default page size is 25, with up to 200 events per page.

Input Parameters

integer
Page number for pagination. Use this to navigate through pages of results.
string
Filter events occurring on or before this date. Format: YYYY-MM-DD
integer
Number of records to fetch per page. Default is 25. Maximum allowed value is 200.
string
Filter events occurring on or after this date. Format: YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination (1-indexed).
integer
The number of records to return per page (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
integer
Filter by invoice ID (exact match).
string ("draft" | "pending" | "open" | "paid" | "voided" | "canceled" | "all")
Filter by invoice status. Use ‘all’ to include all statuses.
string
Filter by end date (YYYY-MM-DD format, inclusive).
string
The date field to filter by. One of: issue_date, due_date, created_at, updated_at.
integer
Filter by product ID.
string
Filter by start date (YYYY-MM-DD format, inclusive).
integer
Filter by customer ID.
integer
Filter by subscription ID.
integer
Filter by product family ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination (default 1).
integer
Number of metadata items to return per page (1-200, default 25).
string ("customers" | "subscriptions" | "sites")
required
The type of resource to list metadata for. Valid values: customers, subscriptions, sites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination.
integer
The number of records to return per page (1-200, default 25).
string ("customers" | "subscriptions" | "products" | "product_families")
required
The type of resource to list metafields for. Valid values: customers, subscriptions, products, product_families.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination.
string
Filter movements occurring on or before this date (YYYY-MM-DD format).
integer
The number of records to return per page (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
string
Filter movements occurring on or after this date (YYYY-MM-DD format).
string
The date field to filter by. One of: created_at, effective_date.
integer
Filter by customer ID.
string ("new" | "activation" | "reactivation" | "expansion" | "contraction" | "cancellation" | "churn" | "downgrade" | "upgrade" | "refund" | "adjustment")
Types of MRR movements.
integer
Filter by subscription ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Result records are organized in pages. By default, the first page of results is displayed.
string
Submit a timestamp in ISO8601 format to request MRR for a historic time.
integer
This parameter indicates how many records to fetch in each request (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
array
Submit subscription IDs in order to limit results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination.
integer
The number of records to return per page (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
array
Filter by offer IDs.
string
Filter by offer handle (exact match).
string
Filter offers created/updated on or before this date (YYYY-MM-DD format).
string
The date field to filter by. One of: created_at, updated_at.
string
Filter by offer type.
integer
Filter by product ID.
string
Filter offers created/updated on or after this date (YYYY-MM-DD format).
string ("not_archived" | "archived" | "both")
Filter for archival state of offers.
integer
Filter by subscription ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination (default: 1).
string
Comma-separated list of related resources to include (e.g., ‘customer’).
integer
The number of records to return per page (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
integer
Filter payment profiles by customer ID. When provided, only profiles for this customer are returned.
string
Filter by vault token to find profiles stored in an external vault.
string
Filter by the current vault where card data is stored. Examples: ‘stripe’, ‘braintree’, ‘authorizenet’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_LIST_PREPAYMENTSLists a page of prepayments for a subscription in Maxio Advanced Billing. Supports pagination and returns available prepayment details such as amounts, payment methods, and balances.

Input Parameters

integer
Page number for pagination (default 1).
integer
Number of prepayments to return per page (1-200, default 25).
integer
required
The Chargify subscription ID for which to list prepayments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination.
integer
The number of records to return per page (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
array
Filter by product family IDs.
string
Filter by product family handle (exact match).
array
Filter by multiple product family handles.
string
Filter product families created/updated on or before this date (YYYY-MM-DD format).
string
The date field to filter by. One of: created_at, updated_at.
string
Filter product families created/updated on or after this date (YYYY-MM-DD format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Defaults to 1 if not specified.
integer
Number of price points to return per page (1-200). Defaults to 25.
string
required
The ID or handle of the product to list price points for. When using handle, prefix with ‘handle:’.
string
Filter by price point status. One of: active, archived, both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination.
integer
The number of records to return per page (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
array
Filter by product IDs.
string ("active" | "archived" | "both")
State filter for products.
string
Filter by product handle (exact match).
array
Filter by multiple product handles.
string
Filter products created/updated on or before this date (YYYY-MM-DD format).
string
The date field to filter by. One of: created_at, updated_at.
string
Filter products created/updated on or after this date (YYYY-MM-DD format).
integer
Filter by product family ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_LIST_PRODUCTS_FOR_PRODUCT_FAMILYLists products within a specified Maxio/Chargify product family. Use pagination to browse the family’s subscription products, for example when displaying plans or auditing product offerings.

Input Parameters

integer
The page number for pagination (1-indexed).
integer
Number of records to return per page (1-200, default 25).
integer
required
The Chargify id of the product family whose products to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination (default 1)
integer
Number of proforma invoices to return per page (1-200, default 25)
integer
required
The numeric ID of the subscription to list proforma invoices for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination.
integer
The number of records to return per page (1-200, default 25).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_LIST_SERVICE_CREDITSLists service credits for a subscription in Maxio Advanced Billing, including amounts, memos, and creation timestamps. This read-only operation returns paginated results; use page and per_page to retrieve credit history.

Input Parameters

integer
Page number for pagination (default 1).
integer
Number of service credits to return per page (1-200, default 25).
integer
required
The Chargify subscription ID for which to list service credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination (default 1).
integer
Number of records to return per page (1-200, default 25).
integer
required
The numeric ID of the subscription whose components to list.
integer
Filter by a specific component ID.
integer
Filter by a specific price point ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination (default 1).
string
The attribute by which to sort results.
string
Include additional data in the response. Use ‘subscription’ to include subscription details.
string
Filter components by date on or before this date (YYYY-MM-DD format).
integer
Number of records to return per page (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
string
The type of filter to apply to the search. One of: created_at, updated_at.
string
Filter components by date on or after this date (YYYY-MM-DD format).
string
Filter components by datetime on or before this time (YYYY-MM-DD HH:MM:SS format). If provided, this takes precedence over end_date.
string
Filter components by datetime on or after this time (YYYY-MM-DD HH:MM:SS format). If provided, this takes precedence over start_date.
array
Filter components by price point IDs.
array
Filter components by subscription IDs.
string
Filter components by currency codes (comma-separated).
array
Filter components by product family IDs.
string
Filter components by subscription states. To use this filter, include ‘subscription’ in the ‘include’ parameter.
string
Filter components belonging to subscriptions created/updated on or before this date (YYYY-MM-DD). To use this filter, include ‘subscription’ in the ‘include’ parameter.
boolean
Filter components by whether they use the site’s exchange rate.
string
The date field type to filter subscriptions by. To use this filter, include ‘subscription’ in the ‘include’ parameter.
string
Filter components belonging to subscriptions created/updated on or after this date (YYYY-MM-DD). To use this filter, include ‘subscription’ in the ‘include’ parameter.
string
Filter components belonging to subscriptions created/updated on or before this datetime (YYYY-MM-DD HH:MM:SS). To use this filter, include ‘subscription’ in the ‘include’ parameter.
string
Filter components belonging to subscriptions created/updated on or after this datetime (YYYY-MM-DD HH:MM:SS). To use this filter, include ‘subscription’ in the ‘include’ parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number for pagination (1-indexed).
integer
Number of records to return per page (1-200, default 25).
integer
Return only events with ID greater than or equal to the specified ID. Use for pagination to avoid duplicates when scrolling through many results.
integer
Return only events with ID less than or equal to the specified ID. Use for pagination to limit results to a specific range.
string ("asc" | "desc")
The direction to sort events: ‘asc’ for ascending (oldest first) or ‘desc’ for descending (newest first).
integer
required
The numeric ID of the subscription to list events for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination.
integer
The number of records to return per page (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
array
Filter by subscription group IDs.
string ("active" | "past_due" | "canceled" | "subscriber_initiated" | "administrator_initiated")
State filter for subscription groups.
string
Filter subscription groups created/updated on or before this date (YYYY-MM-DD format).
string
The date field to filter by. One of: created_at, updated_at.
string
Filter subscription groups created/updated on or after this date (YYYY-MM-DD format).
integer
Filter by customer ID.
integer
Filter by subscription ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_LIST_SUBSCRIPTION_NOTESLists notes attached to a subscription in Maxio/Chargify Advanced Billing, with pagination. This is a read-only operation.

Input Parameters

integer
The page number to retrieve for pagination.
integer
The number of records to return per page (1-200, default 25).
integer
required
The Chargify id of the subscription

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve for pagination.
string
Field to sort by (e.g., ‘created_at’, ‘updated_at’, ‘state’).
integer
The number of records to return per page (1-200, default 25).
string ("asc" | "desc")
Sort direction for listing results.
array
Filter by subscription IDs.
string ("active" | "canceled" | "trialing" | "paused" | "past_due" | "trial_ended" | "completed" | "suspended" | "expired" | "failed" | "pending" | "any")
Subscription state filter values.
string
Filter subscriptions created/updated on or before this date (YYYY-MM-DD format).
integer
Filter by offer ID.
boolean
Filter to include only subscriptions that are currently on trial.
string
The date field to filter by. One of: created_at, updated_at, activated_at, canceled_at.
string
Filter subscriptions created/updated on or after this date (YYYY-MM-DD format).
array
Filter by product IDs.
array
Filter by coupon codes.
array
Filter by customer IDs.
string
Filter by billing interval. One of: day, week, month, year.
integer
Filter by subscription group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_LIST_USAGESLists usage records for a component on a subscription, with pagination. Results can include quantity, memo, timestamps, and remaining unit balance.

Input Parameters

integer
Page number for pagination (default 1).
integer
Number of usages to return per page (1-200, default 25).
integer
required
The numeric ID of the component to list usages for.
integer
required
The numeric ID of the subscription to list usages for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number for pagination (1-indexed).
integer
Number of records to return per page (1-200, default 25).
boolean
Filter webhooks by active status. When true, returns only active webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The numeric ID of the product to migrate the subscription to
integer
required
The numeric ID of the subscription to migrate to a different product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The numeric ID of the subscription to override
string
A message explaining the cancellation override

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID or handle of the product. When using the handle, it must be prefixed with handle:
string
required
The ID or handle of the price point to promote to default. When using the handle, it must be prefixed with handle:

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The numeric ID of the subscription to pause

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of allocation preview items. Each item specifies the component and quantity to preview.
integer
required
The numeric ID of the subscription to preview allocations for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_PREVIEW_CUSTOMER_INFORMATION_CHANGESPreviews customer information changes for an invoice identified by its UID. The preview uses the invoice’s customer information; proposed replacement details cannot be supplied in the request.

Input Parameters

string
required
The unique identifier of the invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The numeric ID of the subscription to preview a proforma invoice for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether to include trial amounts in the renewal preview. Defaults to false.
integer
required
The numeric ID of the subscription to preview renewal charges for
boolean
Whether to include setup fees in the renewal preview. Defaults to false.
boolean
Whether to include the next charge amount in the preview. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_PREVIEW_SIGNUP_PROFORMA_INVOICEPreviews a signup proforma invoice for a product and customer before creating a subscription. Returns modeled invoice details that may include line items and amounts.

Input Parameters

string
required
The handle of the product/pricing plan to preview
object
required
Customer information for the signup preview
string
Payment collection method (e.g., ‘automatic’, ‘reminder’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of days until the subscription invoice is due (0 = immediate)
string
Purchase order number for the subscription
string
Date/time to end the trial period (ISO 8601 format, e.g., ‘2024-12-01T00:00:00Z’)
array
Component allocation settings as list of component configurations
integer
The ID of the product (required if product_handle not provided)
integer
The ID of an existing customer to associate with this subscription (required if not providing customer attributes)
string
Token from a payment vault for an already stored payment method
array
List of coupon codes to apply to the subscription
string
The vault where the card is stored (e.g., ‘stripe’, ‘braintree’, ‘authorizenet’)
array
Custom field values as list of name/value objects
string
A tokenized payment method from a payment gateway (e.g., ‘tok_visa’)
string
Referral code to apply to the subscription
string
The handle of the product (required if product_id not provided)
integer
The ID of an existing payment profile to use for billing
object
Customer attributes for inline customer creation in the preview.
object
Credit card attributes for direct card entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The current product ID of the subscription (optional, will be looked up if not provided)
boolean
Whether to include migrated child subscriptions in the preview
integer
required
The numeric ID of the product to migrate the subscription to
integer
required
The numeric ID of the subscription to preview migration for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the component that owns the price point to promote.
integer
required
The ID of the price point to promote to default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The numeric ID of the subscription to reactivate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the subscription group to reactivate. This is the uid from the subscription group object, not the numeric id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify subscription ID for which to retrieve account balances.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the subscription for which to retrieve the advance invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Either the Chargify id of the component or the handle for the component prefixed with handle:.
integer
required
The Chargify id of the product family to which the component belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique handle used to identify the component.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the component that owns the price point.
integer
required
The ID of the price point to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the coupon
integer
required
The Chargify id of the product family to which the coupon belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique coupon code to search for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the coupon to retrieve usage for
integer
required
The Chargify id of the product family that owns the coupon

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 note

Input Parameters

string
required
The unique identifier of the credit note (e.g., ‘cn_c4rkvt4hqd8d2’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The customer’s reference value (external identifier)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter events created on or after this datetime (ISO 8601 format, e.g., ‘2024-01-01T00:00:00Z’).
string
Filter events created on or before this datetime (ISO 8601 format, e.g., ‘2024-12-31T23:59:59Z’).
string
A filter key to narrow down results. Format depends on the filter type (e.g., ‘subscription_id=12345’).
string
Filter by event type. Common event types include: subscription_created, subscription_updated, subscription_canceled, subscription_activated, subscription_paused, payment_success, payment_failed, invoice_created, invoice_paid, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the invoice to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the invoice export batch job. This is the ID returned when initiating an invoice export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the offer to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the payment profile to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the product to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique handle identifier for the product. This is a URL-friendly string that identifies the product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the product family

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID or handle of the product. When using the handle, prefix with ‘handle:’.
string
required
The ID or handle of the price point to retrieve. When using the handle, prefix with ‘handle:’.
boolean
When fetching a product’s price points, if you have defined multiple currencies at the site level, you can optionally pass the ?currency_prices=true query param to include an array of currency price data in the response. If the product price point is set to use_site_exchange_rate: true, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the proforma invoice to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the export batch job (returned when initiating the export)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the reason code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Allows including additional data in the response (e.g., ‘customer,product,payment_profile’)
integer
required
The Chargify id of the subscription to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The external reference identifier to look up the subscription

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the component. Alternatively, the component’s handle prefixed by handle:.
integer
required
The Chargify id of the subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the note to retrieve
integer
required
The Chargify id of the subscription associated with the note

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the subscription export batch job. This is the ID returned when initiating a subscription export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of events to record. Each event specifies quantity, memo, and optional recorded_at timestamp.
integer
required
The numeric ID of the metered component to record events against.
integer
required
The numeric ID of the subscription to record events for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
An optional description or note for the payment that will appear on the invoice
string
required
The payment amount as a decimal string (e.g., ‘10.00’). This represents the amount being paid for the invoice.
string
required
The unique identifier of the invoice to record a payment for
string
The payment method used for the payment. Defaults to the subscription’s default payment method if not specified. Common values include: ‘credit_card’, ‘ach’, ‘paypal’, ‘bank_transfer’.
string
The receipt amount for the payment. If not specified, it defaults to the payment amount. Useful for scenarios where the payment amount differs from the receipt amount.
string
The external card ID for the payment. If not specified, the default payment profile for the subscription will be used. Format depends on your gateway.
integer
The internal ID of the payment profile to use for the payment. If not specified, the default payment profile for the subscription will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the invoice to refund
string
An optional memo or note to attach to the refund transaction.
string
required
The refund amount as a decimal string (e.g., ‘5.00’). Must be less than or equal to the invoice’s paid amount.
string
required
The reason for the refund. This will be recorded in the transaction history.
integer
The specific payment ID to refund. If not specified, the most recent payment will be refunded. Use this when you need to refund a specific payment on an invoice with multiple payments.
boolean
Set to true if the refund was made outside of the normal payment gateway. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A description or note for the refund. This will appear in the transaction history.
string
The amount to refund as a decimal string (e.g., ‘10.00’). Either amount or amount_in_cents must be provided, but not both.
boolean
Whether the refund is external. When the prepayment is external, this flag is optional. But if the prepayment was made through a payment profile, this flag is required.
integer
required
The ID of the prepayment to refund
integer
The amount to refund in cents (e.g., 1000 for $10.00). Either amount or amount_in_cents must be provided, but not both.
integer
required
The Chargify subscription ID that owns the prepayment to refund

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_REMOVE_COUPON_FROM_SUBSCRIPTIONRemoves an applied coupon from a subscription in Maxio Advanced Billing. Use this to remove a promotional discount from an existing subscription; if multiple coupons are applied, all are removed.

Input Parameters

integer
required
The numeric ID of the subscription from which to remove the coupon

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the subscription to remove from its group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the invoice to reopen

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
An array of webhook IDs to replay. These are the unique identifiers of the webhooks you want to resend. You can get webhook IDs from the webhook history or delivery logs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional list of component IDs to selectively reset. If not provided or empty, all component price points will be reset to their default values. If provided, only the specified components will be reset.
integer
required
The unique identifier of the subscription whose component price points should be reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The numeric ID of the subscription to resume

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The numeric ID of the subscription to retry payment for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the customer for whom to revoke portal access

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the invoice to send
array
Optional list of email addresses to send the invoice to. If not provided, the default recipient(s) from the invoice will be used.
array
Optional list of email addresses to CC on the invoice delivery
array
Optional list of email addresses to BCC on the invoice delivery

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the subscription for which to request a payment profile update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the component to which the price point belongs
integer
required
The Chargify id of the price point to unarchive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The Chargify id of the offer to unarchive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The id or handle of the product. When using the handle, it must be prefixed with handle:
string
required
The id or handle of the price point. When using the handle, it must be prefixed with handle:

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The numeric ID of the subscription for which to update automatic resumption
boolean
required
When set to true, the subscription will automatically resume at the end of the paused period. When false, the subscription will remain paused until manually resumed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_UPDATE_COMPONENTUpdates an existing Chargify billing component’s name and optionally its description, pricing scheme, and other attributes. The component ID and name are required.

Input Parameters

string
required
The new name of the component
string
A unique identifier (handle) for the component
array
Array of price tiers to set for the component
boolean
Whether the component is archived
string
A tax code identifying what tax rules apply to this component
string
The name of the unit (e.g., ‘requests’, ‘GB’, ‘users’)
string
The new description of the component
integer
required
The Chargify id of the component to update
string ("per_unit" | "tiered" | "volume" | "stair_step")
Pricing scheme for the component.
string
The type of charge to apply when upgrading mid-period: ‘prorated’ or ‘immediate’
string
The type of credit to apply when downgrading mid-period: ‘prorated’ or ‘none’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Nested price_point object sent in the update request body.
integer
required
The Chargify id of the component to which the price point belongs.
integer
required
The Chargify id of the price point to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_UPDATE_COUPONUpdates an existing coupon within a Maxio product family using the supplied coupon attributes, such as name, code, discount settings, expiration date, or redemption limits. The product family ID and coupon ID are required.

Input Parameters

string
The coupon code. Must be unique within the product family.
string
The name of the coupon
string ("forever" | "single_use" | "repeating")
Duration of the coupon validity.
integer
required
The Chargify id of the coupon to update
boolean
Whether the coupon can be stacked with other coupons
integer
Length of the auto-generated coupon code (if code is not provided)
string
Description of the coupon
string ("percentage" | "fixed" | "apply_on_each_renewal")
Type of discount for the coupon.
string
Fixed discount amount (when discount_type is ‘fixed’)
string
Expiration date of the coupon in YYYY-MM-DD format
integer
Maximum number of redemptions allowed
integer
Number of billing intervals for repeating coupons (1-12)
integer
required
The Chargify id of the product family to which the coupon belongs
string
Percentage discount (when discount_type is ‘percentage’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of subcode strings to set for the coupon. This will replace all existing subcodes. Each code must be unique and not already exist on the coupon. Maximum of 1000 codes per request.
integer
required
The Chargify ID of the coupon to update subcodes for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Nested customer object sent in the update request body. All fields are optional.
integer
required
The Chargify id of the customer to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The customer object containing the fields to update. At least one field must be provided.
string
required
The unique identifier of the invoice (e.g., inv_c4rkt53zt457x)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Nested endpoint object sent in the update request body.
integer
required
The Chargify id of the endpoint that should be updated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Card Verification Value (CVV/CVC) - the 3 or 4 digit security code on the back of the card.
string
Company name associated with the payment profile.
string
Last name of the cardholder as it appears on the credit card.
string
First name of the cardholder as it appears on the credit card.
string
ZIP or postal code for the billing address.
string
Credit card number (full 16-digit card number). The card number will be tokenized by the payment gateway.
string
Token representing a payment method already stored in the payment vault (e.g., from a previous transaction). If provided, other card details may not be needed.
string
City for the billing address.
string
State or province for the billing address.
string
The vault where the card data is already stored. Examples: ‘stripe’, ‘braintree’, ‘authorizenet’.
string
A tokenized payment method token from a payment gateway.
string
Street address for the billing address.
string
Country code (2-letter ISO code) for the billing address.
integer
Expiration year of the credit card (4-digit year).
integer
Expiration month of the credit card (1-12).
integer
required
The Chargify id of the payment profile to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The new expiration date for the prepaid allocation. Format: YYYY-MM-DD.
integer
required
The Chargify id of the component. This is the numeric ID of the component.
integer
required
The Chargify id of the allocation. This is the numeric ID of the allocation to update.
integer
required
The Chargify id of the subscription. This is the numeric ID of the subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Nested product object sent in the update request body. All fields are optional.
integer
required
The Chargify id of the product to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Component fields that can be updated via PUT /product_families/{product_family_id}/components/{component_id}. All fields are optional - only provided fields will be updated.
string
required
Either the Chargify id of the component or the handle for the component prefixed with handle:.
integer
required
The Chargify id of the product family to which the component belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID or handle of the product. When using handle, prefix with ‘handle:’.
object
required
The price point object containing the fields to update. At least one field must be provided.
string
required
The ID or handle of the price point to update. When using handle, prefix with ‘handle:’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Nested reason code object sent in the update request body. All fields are optional.
integer
required
The Chargify id of the reason code to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Subscription update fields that can be modified. All fields are optional.
integer
required
The Chargify ID of the subscription to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of component price point updates. Each entry specifies a component_id and the price_point_id to assign to it. Updates are applied sequentially and are NOT atomic - individual updates may succeed or fail independently. If one update fails, previously successful updates will not be rolled back.
string
required
The unique identifier of the subscription. Can be the Chargify subscription ID or its alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The updated content/body of the note
boolean
Whether the note should be marked as sticky. Sticky notes are displayed prominently.
integer
required
The Chargify note ID to update
integer
required
The Chargify subscription ID the note belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAXIO_VALIDATE_COUPONValidates a coupon code in Maxio Advanced Billing before applying it to a subscription. This read-only operation does not redeem the coupon.

Input Parameters

string
required
The coupon code to validate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The reason for voiding the advance invoice
string
required
The unique identifier of the advance invoice to void
integer
required
The ID of the subscription whose advance invoice should be voided

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
The reason for voiding the invoice. Providing a reason helps with audit trails.
string
required
The unique identifier of the invoice to void

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not