Maxio
maxioSubscription billing and revenue management platform (formerly Chargify)
Acciones disponibles (177)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Allocate ComponentMAXIO_ALLOCATE_COMPONENTAcciónCreates 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.
MAXIO_ALLOCATE_COMPONENTAcciónCreates 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.
Parámetros de entrada
memostringAn optional memo or note describing the allocation
quantityintegerObligatorioThe 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.
accrual_datestringThe date on which to begin charging for the allocation. Only applicable for components with 'immediate' billing timing. Format: YYYY-MM-DD.
component_idintegerObligatorioThe component ID to allocate. This is the numeric ID of the component.
proration_datestringThe 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.
allocation_typestringenumThe type of allocation action. Use 'initial' for new allocations, 'upgrade' or 'downgrade' for quantity changes, 'cancellation' when ending the component, or 'reactivation' when resuming.
initialupgradedowngradecancellationreactivationsubscription_idintegerObligatorioThe subscription ID to allocate the component on. This is the numeric ID of the subscription.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Apply Coupons to SubscriptionMAXIO_APPLY_COUPONS_TO_SUBSCRIPTIONAcciónApplies one or more coupons to a subscription. Use when you need to apply promotional discounts or coupon codes to an existing subscription. The coupon must be valid and not expired for the operation to succeed.
MAXIO_APPLY_COUPONS_TO_SUBSCRIPTIONAcciónApplies one or more coupons to a subscription. Use when you need to apply promotional discounts or coupon codes to an existing subscription. The coupon must be valid and not expired for the operation to succeed.
Parámetros de entrada
codestringObligatorioThe coupon code to apply to the subscription
subscription_idintegerObligatorioThe ID of the subscription to apply the coupon to
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive ComponentMAXIO_ARCHIVE_COMPONENTAcciónArchives 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.
MAXIO_ARCHIVE_COMPONENTAcciónArchives 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.
Parámetros de entrada
component_idstringObligatorioEither the Chargify id of the component or the handle for the component prefixed with `handle:`
product_family_idintegerObligatorioThe Chargify id of the product family to which the component belongs
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive Component Price PointMAXIO_ARCHIVE_COMPONENT_PRICE_POINTAcciónArchives 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).
MAXIO_ARCHIVE_COMPONENT_PRICE_POINTAcciónArchives 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).
Parámetros de entrada
component_idintegerObligatorioThe Chargify id of the component to which the price point belongs
price_point_idintegerObligatorioThe Chargify id of the price point to archive
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive CouponMAXIO_ARCHIVE_COUPONAcciónArchives 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.
MAXIO_ARCHIVE_COUPONAcciónArchives 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.
Parámetros de entrada
coupon_idintegerObligatorioThe Chargify id of the coupon to archive
product_family_idintegerObligatorioThe Chargify id of the product family to which the coupon belongs
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive OfferMAXIO_ARCHIVE_OFFERAcciónArchives 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.
MAXIO_ARCHIVE_OFFERAcciónArchives 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.
Parámetros de entrada
offer_idintegerObligatorioThe Chargify id of the offer to archive
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive ProductMAXIO_ARCHIVE_PRODUCTAcciónArchives 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.
MAXIO_ARCHIVE_PRODUCTAcciónArchives 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.
Parámetros de entrada
product_idintegerObligatorioThe Chargify id of the product to archive
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive product price pointMAXIO_ARCHIVE_PRODUCT_PRICE_POINTAcciónArchives 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.
MAXIO_ARCHIVE_PRODUCT_PRICE_POINTAcciónArchives 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.
Parámetros de entrada
product_idstringObligatorioThe id or handle of the product. When using the handle, it must be prefixed with `handle:`
price_point_idstringObligatorioThe id or handle of the price point. When using the handle, it must be prefixed with `handle:`
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Cancel Delayed CancellationMAXIO_CANCEL_DELAYED_CANCELLATIONAcciónCancels 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.
MAXIO_CANCEL_DELAYED_CANCELLATIONAcciónCancels 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.
Parámetros de entrada
subscription_idintegerObligatorioThe ID of the subscription for which to cancel the delayed cancellation
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Clone Component Price PointMAXIO_CLONE_COMPONENT_PRICE_POINTAcciónClones 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.
MAXIO_CLONE_COMPONENT_PRICE_POINTAcciónClones 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.
Parámetros de entrada
namestringName for the cloned price point. If not provided, the API will generate a default name.
component_idintegerObligatorioThe ID of the component that owns the price point to clone.
price_point_idintegerObligatorioThe ID of the price point to clone.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Bulk Create Product Price PointsMAXIO_CREATE_BULK_PRODUCT_PRICE_POINTSAcciónCreates 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.
MAXIO_CREATE_BULK_PRODUCT_PRICE_POINTSAcciónCreates 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.
Parámetros de entrada
product_idstringObligatorioThe ID or handle of the product to create price points for. When using handle, prefix with 'handle:'.
price_pointsobject[]ObligatorioArray of price point objects to create. Each price point must have a unique name within the product.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ComponentMAXIO_CREATE_COMPONENTAcciónCreates 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).
MAXIO_CREATE_COMPONENTAcciónCreates 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).
Parámetros de entrada
component_kindstringObligatorioenumThe component kind. Use the plural form: metered_components, quantity_based_components, on_off_components, prepaid_usage_components, or event_based_components.
metered_componentsquantity_based_componentson_off_componentsprepaid_usage_componentsevent_based_componentson_off_componentobjectOn/off component configuration.
metered_componentobjectMetered component configuration.
product_family_idintegerObligatorioThe Chargify id of the product family to which the component belongs.
event_based_componentobjectEvent-based component configuration.
prepaid_usage_componentobjectPrepaid usage component configuration.
quantity_based_componentobjectQuantity-based component configuration.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Component Price PointMAXIO_CREATE_COMPONENT_PRICE_POINTAcciónCreates 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.
MAXIO_CREATE_COMPONENT_PRICE_POINTAcciónCreates 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.
Parámetros de entrada
price_pointobjectObligatorioThe price point object containing the pricing configuration. Must include name and pricing_scheme at minimum. The prices array is required for all pricing schemes.
component_idintegerObligatorioThe ID of the component for which to create the price point.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Coupon SubcodesMAXIO_CREATE_COUPON_SUBCODESAcciónCreates 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.
MAXIO_CREATE_COUPON_SUBCODESAcciónCreates 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.
Parámetros de entrada
codesstring[]ObligatorioArray 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.
coupon_idintegerObligatorioThe Chargify ID of the coupon to add subcodes to
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create CustomerMAXIO_CREATE_CUSTOMERAcciónCreates 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.
MAXIO_CREATE_CUSTOMERAcciónCreates 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.
Parámetros de entrada
emailstringObligatorioCustomer's email address
phonestringCustomer's phone number
localestringCustomer's preferred locale (e.g., en-US, fr-FR)
addressobjectAddress information for the customer.
cc_emailsstringComma-separated list of additional email addresses to CC on billing notifications
last_namestringObligatorioCustomer's last name
referencestringUnique external identifier for the customer (e.g., from your internal system)
first_namestringObligatorioCustomer's first name
organizationstringOrganization or company name
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Webhook EndpointMAXIO_CREATE_ENDPOINTAcciónCreates a new webhook endpoint in Maxio Advanced Billing. Use when you need to register a new webhook endpoint to receive event notifications.
MAXIO_CREATE_ENDPOINTAcciónCreates a new webhook endpoint in Maxio Advanced Billing. Use when you need to register a new webhook endpoint to receive event notifications.
Parámetros de entrada
urlstringObligatorioThe URL that will receive webhook event notifications. Must be a valid HTTPS URL accessible from the internet.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create InvoiceMAXIO_CREATE_INVOICEAcciónCreates 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.
MAXIO_CREATE_INVOICEAcciónCreates 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.
Parámetros de entrada
line_itemsobject[]ObligatorioList of line items to include on the invoice.
subscription_idstringObligatorioThe ID of the subscription to create the invoice for.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create MetadataMAXIO_CREATE_METADATAAcciónCreates 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.
MAXIO_CREATE_METADATAAcciónCreates 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.
Parámetros de entrada
metadataobject[]ObligatorioList 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.
resource_idintegerObligatorioThe unique identifier of the resource to attach metadata to
resource_typestringObligatorioenumThe type of resource to attach metadata to. Common types include: customers, subscriptions, sites.
customerssubscriptionssites
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create MetafieldsMAXIO_CREATE_METAFIELDSAcciónCreates 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.
MAXIO_CREATE_METAFIELDSAcciónCreates 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.
Parámetros de entrada
metafieldsobject[]ObligatorioArray of metafield definitions to create. Each defines a custom field with its name, data type, and options.
resource_typestringObligatorioThe type of resource to create metafields for. Valid values: customers, subscriptions, products, or product_families.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create or Update Coupon Currency PricesMAXIO_CREATE_OR_UPDATE_COUPON_CURRENCY_PRICESAcciónTool 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.
MAXIO_CREATE_OR_UPDATE_COUPON_CURRENCY_PRICESAcciónTool 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.
Parámetros de entrada
coupon_idintegerObligatorioThe Advanced Billing id of the coupon
currency_pricesobject[]ObligatorioArray of currency price objects to set for the coupon
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Payment ProfileMAXIO_CREATE_PAYMENT_PROFILEAcciónCreates a new payment profile for a customer in Maxio (Chargify). Use when you need to add a new credit card or payment method to a customer's account. The payment profile stores card details securely and returns a vault token for future use.
MAXIO_CREATE_PAYMENT_PROFILEAcciónCreates a new payment profile for a customer in Maxio (Chargify). Use when you need to add a new credit card or payment method to a customer's account. The payment profile stores card details securely and returns a vault token for future use.
Parámetros de entrada
cvvstringCard Verification Value (CVV/CVC) - the 3 or 4 digit security code on the back of the card.
companystringCompany name associated with the payment profile.
last_namestringObligatorioLast name of the cardholder as it appears on the credit card.
first_namestringObligatorioFirst name of the cardholder as it appears on the credit card.
billing_zipstringZIP or postal code for the billing address.
card_numberstringObligatorioCredit card number (full 16-digit card number). The card number will be tokenized by the payment gateway.
customer_idintegerObligatorioThe unique identifier of the customer to associate with this payment profile. Must be a valid customer ID.
vault_tokenstringToken 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.
billing_citystringCity for the billing address.
billing_statestringState or province for the billing address.
current_vaultstringThe vault where the card data is already stored. Examples: 'stripe', 'braintree', 'authorizenet'.
payment_tokenstringA tokenized payment method token from a payment gateway.
charge_accountbooleanWhether to run a $0 authorization to validate the card. Defaults to true if not specified.
billing_addressstringStreet address for the billing address.
billing_countrystringCountry code (2-letter ISO code) for the billing address.
expiration_yearintegerObligatorioExpiration year of the credit card (4-digit year).
expiration_monthintegerObligatorioExpiration month of the credit card (1-12).
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Prepaid Usage ComponentMAXIO_CREATE_PREPAID_USAGE_COMPONENTAcciónCreates 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.
MAXIO_CREATE_PREPAID_USAGE_COMPONENTAcciónCreates 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.
Parámetros de entrada
namestringObligatorioThe name of the prepaid usage component
handlestringA unique identifier for the component within the product family (used for API references). If not provided, will be auto-generated from the name.
pricesobject[]ObligatorioArray of price tiers. For 'per_unit', include one entry with starting_quantity=1. For 'volume' or 'tiered', include multiple tiers with different starting quantities.
tax_codestringThe tax code for the component (used for tax calculations)
unit_namestringObligatorioThe name of the unit for this component (e.g., 'credits', 'calls', 'GB')
descriptionstringA description of what this prepaid usage component represents
pricing_schemestringObligatorioenumThe pricing scheme for the component. Must be 'per_unit', 'volume', 'tiered', or 'stairstep'.
per_unitvolumetieredstairstepupgrade_chargestringUpgrade charge option when upgrading mid-period: 'prorated' (default), 'full', or 'immediate'
accounting_codestringAn accounting code for the component (used for invoicing and reporting)
overage_pricingobjectPricing configuration for usage that exceeds prepaid amounts.
downgrade_creditstringCredit option when downgrading mid-period: 'prorated' (default), 'full', or 'none'
revenue_schedulestringRevenue recognition schedule for the component
product_family_idintegerObligatorioThe ID of the product family to create the component under
use_site_exchange_ratebooleanWhether to use the site's exchange rate for multi-currency pricing. Defaults to true.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create PrepaymentMAXIO_CREATE_PREPAYMENTAcciónCreates 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.
MAXIO_CREATE_PREPAYMENTAcciónCreates 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.
Parámetros de entrada
memostringObligatorioA description or note for the prepayment that will appear on the invoice
amountstringObligatorioThe amount of the prepayment as a decimal string (e.g., '10.00'). This represents the total amount to be charged.
methodstringObligatorioenumThe payment method to use for the prepayment. Must be one of: credit_card, ach, paypal, wire_transfer, or check.
credit_cardachpaypalwire_transfercheckdetailsstringAdditional details or notes about the prepayment. These details will be recorded but not shown on the invoice.
subscription_idintegerObligatorioThe Chargify subscription ID for which to create the prepayment
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ProductMAXIO_CREATE_PRODUCTAcciónTool 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.
MAXIO_CREATE_PRODUCTAcciónTool 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.
Parámetros de entrada
namestringObligatorioThe product name. This is required and must be unique within the product family.
activebooleanWhether the product is active and available for subscription. Inactive products cannot be subscribed to.
handlestringA unique identifier for the product. If not provided, a handle will be auto-generated from the name. Must be unique across the site.
intervalintegerObligatorioThe number of interval units between each billing date. For example, interval=1 with interval_unit='month' means monthly billing.
tax_codestringA tax code for the product to be used in tax calculations. Used by Avalara and other tax integrations.
descriptionstringA detailed description of the product. This value is used for SEO and display purposes.
interval_unitstringObligatorioenumThe unit of time for the billing interval. Valid values: 'day', 'month', 'year', 'week'.
daymonthyearweekprice_in_centsintegerObligatorioThe price in cents. Must be a positive integer representing the amount to charge per billing interval.
trial_intervalintegerThe number of trial intervals before regular billing begins. Should be used with trial_interval_unit.
accounting_codestringAn accounting code for the product to be used in financial reporting and integrations.
product_family_idintegerObligatorioThe unique identifier of the product family to which the product will belong.
expiration_intervalintegerThe number of intervals after which the subscription expires. If not provided, the subscription continues indefinitely.
request_credit_cardbooleanWhether to request credit card information at checkout. Useful for forcing card collection even when the product has no upfront cost.
require_credit_cardbooleanWhether a credit card is required to start the subscription. Defaults to false if not specified.
trial_interval_unitstringenumUnit of time for the billing interval.
daymonthyearweektrial_price_in_centsintegerThe trial price in cents. If provided, the customer will be charged this amount during the trial period instead of the regular price.
initial_charge_in_centsintegerA one-time upfront charge in cents that occurs at subscription creation. Useful for activation fees.
expiration_interval_unitstringenumUnit of time for the billing interval.
daymonthyearweek
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Product FamilyMAXIO_CREATE_PRODUCT_FAMILYAcciónCreates 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.
MAXIO_CREATE_PRODUCT_FAMILYAcciónCreates 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.
Parámetros de entrada
namestringObligatorioThe name of the product family. This field is required.
handlestringA 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.
descriptionstringA text description of the product family
accounting_codestringA code used with your accounting system to track revenue
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Product Price PointMAXIO_CREATE_PRODUCT_PRICE_POINTAcciónCreates 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.
MAXIO_CREATE_PRODUCT_PRICE_POINTAcciónCreates 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.
Parámetros de entrada
product_idstringObligatorioThe ID or handle of the product to create a price point for. When using handle, prefix with 'handle:'.
price_pointobjectObligatorioThe price point object containing the pricing configuration. Must include name at minimum.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Proforma InvoiceMAXIO_CREATE_PROFORMA_INVOICEAcciónCreates a proforma invoice for a subscription. A proforma invoice is a preliminary invoice that shows the expected charges before a final invoice is generated. Use when you need to preview or share expected billing amounts with a customer before finalizing the invoice. Note: This action creates a proforma invoice with an empty body. The response contains the complete proforma invoice details including line items, amounts, and due dates.
MAXIO_CREATE_PROFORMA_INVOICEAcciónCreates a proforma invoice for a subscription. A proforma invoice is a preliminary invoice that shows the expected charges before a final invoice is generated. Use when you need to preview or share expected billing amounts with a customer before finalizing the invoice. Note: This action creates a proforma invoice with an empty body. The response contains the complete proforma invoice details including line items, amounts, and due dates.
Parámetros de entrada
subscription_idintegerObligatorioThe ID of the subscription for which to create a proforma invoice
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Quantity Based ComponentMAXIO_CREATE_QUANTITY_BASED_COMPONENTAcciónCreates 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.
MAXIO_CREATE_QUANTITY_BASED_COMPONENTAcciónCreates 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.
Parámetros de entrada
product_family_idintegerObligatorioThe Chargify id of the product family to which the component belongs.
quantity_based_componentobjectObligatorioConfiguration for the quantity-based component.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Reason CodeMAXIO_CREATE_REASON_CODEAcciónCreates 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.
MAXIO_CREATE_REASON_CODEAcciónCreates 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.
Parámetros de entrada
codestringObligatorioA unique identifier code for the reason code. This is the value that will be used when reporting churn reasons.
positionintegerThe order position of the reason code in lists. Must be a positive integer.
descriptionstringA human-readable description explaining the reason code
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Signup Proforma InvoiceMAXIO_CREATE_SIGNUP_PROFORMA_INVOICEAcciónCreates a proforma invoice for signup preview. A proforma invoice shows the expected charges for a new subscription before it is actually created. Use this action when you need to preview billing amounts for a potential new customer or to share expected costs before finalizing a subscription signup. This action requires a product_id and customer_attributes (first_name, last_name, and email are required). The response contains the complete proforma invoice details including line items, amounts, and due dates.
MAXIO_CREATE_SIGNUP_PROFORMA_INVOICEAcciónCreates a proforma invoice for signup preview. A proforma invoice shows the expected charges for a new subscription before it is actually created. Use this action when you need to preview billing amounts for a potential new customer or to share expected costs before finalizing a subscription signup. This action requires a product_id and customer_attributes (first_name, last_name, and email are required). The response contains the complete proforma invoice details including line items, amounts, and due dates.
Parámetros de entrada
product_idintegerObligatorioThe ID of the product/pricing plan to subscribe to
customer_attributesobjectObligatorioCustomer information for the signup preview
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create SubscriptionMAXIO_CREATE_SUBSCRIPTIONAcciónCreates 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).
MAXIO_CREATE_SUBSCRIPTIONAcciónCreates 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).
Parámetros de entrada
cvvstringCard Verification Value (CVV/CVC)
group_bystringComma-separated list of fields to group the subscription with others
last_namestringLast name on the credit card
net_termsintegerNumber of days until the subscription invoice is due (0 = immediate)
po_numberstringPurchase order number for the subscription
trial_endstringDate/time to end the trial period (ISO 8601 format, e.g., '2024-12-01T00:00:00Z')
componentsobject[]Component allocation settings as list of component configurations
first_namestringFirst name on the credit card
product_idintegerThe ID of the product (required if product_handle not provided)
billing_zipstringBilling ZIP or postal code
card_numberstringFull credit card number (will be tokenized)
customer_idintegerThe ID of an existing customer to associate with this subscription (required if not providing customer attributes)
vault_tokenstringToken from a payment vault for an already stored payment method
billing_citystringBilling city
coupon_codesstring[]List of coupon codes to apply to the subscription
billing_statestringBilling state or province
current_vaultstringThe vault where the card is stored (e.g., 'stripe', 'braintree', 'authorizenet')
custom_fieldsobject[]Custom field values as list of name/value objects
payment_tokenstringA tokenized payment method from a payment gateway (e.g., 'tok_visa')
referral_codestringReferral code to apply to the subscription
customer_emailstringCustomer's email address (use when creating customer inline)
customer_phonestringCustomer's phone number
product_handlestringThe handle of the product (required if product_id not provided)
billing_addressstringBilling street address
billing_countrystringBilling country code (2-letter ISO code)
expiration_yearintegerExpiration year of the credit card (4-digit year)
expiration_monthintegerExpiration month of the credit card (1-12)
customer_last_namestringCustomer's last name (use when creating customer inline)
customer_referencestringExternal reference for customer
payment_profile_idintegerThe ID of an existing payment profile to use for billing
customer_first_namestringCustomer's first name (use when creating customer inline)
customer_organizationstringCustomer's organization (use when creating customer inline)
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Subscription Group With SignupMAXIO_CREATE_SUBSCRIPTION_GROUP_WITH_SIGNUPAcciónCreates 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.
MAXIO_CREATE_SUBSCRIPTION_GROUP_WITH_SIGNUPAcciónCreates 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.
Parámetros de entrada
payer_idintegerID of an existing customer to use as the payer. If provided, payer_attributes can be omitted or will be ignored.
subscriptionsobject[]ObligatorioList of subscriptions to create in the group. At least one subscription is required.
payer_attributesobjectCustomer attributes for subscription creation.
payment_profile_idintegerID of an existing payment profile belonging to the payer. Required for subscription group signup.
payment_collection_chargestringWhen to charge the payment method for the group. One of: 'at_signup', 'at_review', 'immediately', 'end_of_period'.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Subscription NoteMAXIO_CREATE_SUBSCRIPTION_NOTEAcciónCreates 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.
MAXIO_CREATE_SUBSCRIPTION_NOTEAcciónCreates 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.
Parámetros de entrada
bodystringObligatorioThe content/body of the note to be created
created_atstringTimestamp for when the note was created (UTC, format: YYYY-MM-DDTHH:MM:SSZ). If not provided, current time will be used.
subscription_idintegerObligatorioThe Chargify subscription ID to attach the note to
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create UsageMAXIO_CREATE_USAGEAcciónRecords 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
MAXIO_CREATE_USAGEAcciónRecords 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
Parámetros de entrada
memostringA memo describing the usage. This will appear on the invoice line item.
quantitynumberObligatorioThe quantity of usage to record. Can be a decimal value for proration.
recorded_atstringThe time the usage was recorded, in ISO 8601 format (e.g., '2024-01-15T10:30:00Z'). Defaults to the current time if not specified.
component_idintegerObligatorioThe numeric ID of the metered component to record usage against.
subscription_idintegerObligatorioThe numeric ID of the subscription to record usage for.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Deactivate Event Based ComponentMAXIO_DEACTIVATE_EVENT_BASED_COMPONENTAcciónDeactivates an event-based component on a subscription. Use when you need to disable event-based billing on a subscription, such as pausing usage tracking or stopping billing for a specific component. This action is commonly used to: - Pause event-based billing temporarily - Stop collecting events for a specific component - Deactivate a component before removing it from a subscription The endpoint requires both the subscription ID and component ID as path parameters. This action is reversible — the component can be reactivated using the corresponding activate action.
MAXIO_DEACTIVATE_EVENT_BASED_COMPONENTAcciónDeactivates an event-based component on a subscription. Use when you need to disable event-based billing on a subscription, such as pausing usage tracking or stopping billing for a specific component. This action is commonly used to: - Pause event-based billing temporarily - Stop collecting events for a specific component - Deactivate a component before removing it from a subscription The endpoint requires both the subscription ID and component ID as path parameters. This action is reversible — the component can be reactivated using the corresponding activate action.
Parámetros de entrada
component_idintegerObligatorioThe Chargify id of the component
subscription_idintegerObligatorioThe Chargify id of the subscription
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Deduct Service CreditMAXIO_DEDUCT_SERVICE_CREDITAcciónDeducts 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.
MAXIO_DEDUCT_SERVICE_CREDITAcciónDeducts 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.
Parámetros de entrada
memostringAn optional description or note for the service credit deduction. This will appear in the transaction history.
amountstringObligatorioThe amount to deduct from the subscription's service credit balance as a decimal string (e.g., '10.00'). Must be a positive value.
subscription_idintegerObligatorioThe Chargify subscription ID from which to deduct the service credit
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Coupon SubcodeMAXIO_DELETE_COUPON_SUBCODEAcciónDeletes 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.
MAXIO_DELETE_COUPON_SUBCODEAcciónDeletes 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.
Parámetros de entrada
subcodestringObligatorioThe subcode string to delete from the coupon
coupon_idintegerObligatorioThe Chargify id of the coupon to which the subcode belongs
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CustomerMAXIO_DELETE_CUSTOMERAcciónDeletes a customer from Maxio/Chargify. Use this action when you need to permanently remove a customer record. This action is irreversible — once deleted, the customer cannot be recovered. Note: A customer can only be deleted if they have no associated subscriptions. Attempting to delete a customer with active subscriptions will result in an error.
MAXIO_DELETE_CUSTOMERAcciónDeletes a customer from Maxio/Chargify. Use this action when you need to permanently remove a customer record. This action is irreversible — once deleted, the customer cannot be recovered. Note: A customer can only be deleted if they have no associated subscriptions. Attempting to delete a customer with active subscriptions will result in an error.
Parámetros de entrada
customer_idintegerObligatorioThe Chargify id of the customer to delete
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Prepaid Usage AllocationMAXIO_DELETE_PREPAID_USAGE_ALLOCATIONAcciónDeletes 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.
MAXIO_DELETE_PREPAID_USAGE_ALLOCATIONAcciónDeletes 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.
Parámetros de entrada
component_idintegerObligatorioThe Chargify id of the component. This is the numeric ID of the component.
allocation_idintegerObligatorioThe Chargify id of the allocation. This is the numeric ID of the allocation to delete.
subscription_idintegerObligatorioThe Chargify id of the subscription. This is the numeric ID of the subscription.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Reason CodeMAXIO_DELETE_REASON_CODEAcciónDeletes 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.
MAXIO_DELETE_REASON_CODEAcciónDeletes 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.
Parámetros de entrada
reason_code_idintegerObligatorioThe Chargify id of the reason code to delete
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Subscription GroupMAXIO_DELETE_SUBSCRIPTION_GROUPAcciónDeletes a subscription group and all its associated data. Use this action when you need to permanently remove a subscription group from the system. This action is irreversible — once deleted, the subscription group and all its subscriptions cannot be recovered.
MAXIO_DELETE_SUBSCRIPTION_GROUPAcciónDeletes a subscription group and all its associated data. Use this action when you need to permanently remove a subscription group from the system. This action is irreversible — once deleted, the subscription group and all its subscriptions cannot be recovered.
Parámetros de entrada
uidstringObligatorioThe unique identifier (uid) of the subscription group to delete. This is the uid from the subscription group object, not the numeric id.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Subscription NoteMAXIO_DELETE_SUBSCRIPTION_NOTEAcciónDeletes 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.
MAXIO_DELETE_SUBSCRIPTION_NOTEAcciónDeletes 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.
Parámetros de entrada
note_idintegerObligatorioThe Chargify id of the note to delete
subscription_idintegerObligatorioThe Chargify id of the subscription
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Subscription Payment ProfileMAXIO_DELETE_SUBSCRIPTION_PAYMENT_PROFILEAcciónRemoves 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.
MAXIO_DELETE_SUBSCRIPTION_PAYMENT_PROFILEAcciónRemoves 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.
Parámetros de entrada
subscription_idintegerObligatorioThe Chargify id of the subscription to which the payment profile belongs
payment_profile_idintegerObligatorioThe Chargify id of the payment profile to remove from the subscription
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Unused Payment ProfileMAXIO_DELETE_UNUSED_PAYMENT_PROFILEAcciónPermanently 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).
MAXIO_DELETE_UNUSED_PAYMENT_PROFILEAcciónPermanently 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).
Parámetros de entrada
payment_profile_idintegerObligatorioThe Chargify id of the payment profile to delete. Only unused payment profiles can be deleted.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Deliver Proforma InvoiceMAXIO_DELIVER_PROFORMA_INVOICEAcciónDelivers 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.
MAXIO_DELIVER_PROFORMA_INVOICEAcciónDelivers 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.
Parámetros de entrada
recipient_emailsstring[]Optional list of email addresses to send the proforma invoice to. If not provided, the default recipient(s) from the invoice will be used.
cc_recipient_emailsstring[]Optional list of email addresses to CC on the proforma invoice delivery
bcc_recipient_emailsstring[]Optional list of email addresses to BCC on the proforma invoice delivery
proforma_invoice_uidstringObligatorioThe unique identifier of the proforma invoice to deliver
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Enable WebhooksMAXIO_ENABLE_WEBHOOKSAcciónEnables 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.
MAXIO_ENABLE_WEBHOOKSAcciónEnables 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.
Parámetros de entrada
enabledbooleanObligatorioWhen set to true, webhooks will be enabled and events will be sent to registered endpoints. When set to false, webhooks will be disabled.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export InvoicesMAXIO_EXPORT_INVOICESAcciónInitiates 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'.
MAXIO_EXPORT_INVOICESAcciónInitiates 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'.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export Proforma InvoicesMAXIO_EXPORT_PROFORMA_INVOICESAcciónInitiates 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.
MAXIO_EXPORT_PROFORMA_INVOICESAcciónInitiates 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export SubscriptionsMAXIO_EXPORT_SUBSCRIPTIONSAcciónInitiates an asynchronous export of subscription data from Maxio/Chargify. Use this action when you need to export bulk subscription data for analysis, backup, or integration with external systems. The export runs asynchronously and returns a download URL when complete. Note: Export processing may take several minutes for large datasets.
MAXIO_EXPORT_SUBSCRIPTIONSAcciónInitiates an asynchronous export of subscription data from Maxio/Chargify. Use this action when you need to export bulk subscription data for analysis, backup, or integration with external systems. The export runs asynchronously and returns a download URL when complete. Note: Export processing may take several minutes for large datasets.
Parámetros de entrada
pageintegerPage number for pagination when export is paginated
statusstringFilter by subscription status. One of: active, canceled, trial, paused, expired, pending
end_datestringdateFilter subscriptions modified on or before this date (YYYY-MM-DD format)
per_pageintegerNumber of records per page (1-200, default 25)
date_fieldstringThe subscription date field to filter by. One of: created_at, updated_at, activated_at, canceled_at
start_datestringdateFilter subscriptions modified on or after this date (YYYY-MM-DD format)
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get MRRMAXIO_GET_MRRAcciónReturns 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.
MAXIO_GET_MRRAcciónReturns 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.
Parámetros de entrada
at_timestringSubmit a timestamp in ISO8601 format to request MRR for a historic time.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Initiate Delayed CancellationMAXIO_INITIATE_DELAYED_CANCELLATIONAcciónSchedules 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.
MAXIO_INITIATE_DELAYED_CANCELLATIONAcciónSchedules 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.
Parámetros de entrada
subscription_idintegerObligatorioThe numeric ID of the subscription to schedule for cancellation at end of period
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Issue Advance InvoiceMAXIO_ISSUE_ADVANCE_INVOICEAcciónIssues an advance invoice for a subscription. An advance invoice allows billing for upcoming charges in advance of the normal billing cycle. Use this action when you need to immediately bill a customer for expected charges before the regular billing date arrives. Note: This action requires a valid subscription_id. The response contains the complete advance invoice details including line items, amounts, and due dates.
MAXIO_ISSUE_ADVANCE_INVOICEAcciónIssues an advance invoice for a subscription. An advance invoice allows billing for upcoming charges in advance of the normal billing cycle. Use this action when you need to immediately bill a customer for expected charges before the regular billing date arrives. Note: This action requires a valid subscription_id. The response contains the complete advance invoice details including line items, amounts, and due dates.
Parámetros de entrada
subscription_idintegerObligatorioThe ID of the subscription for which to issue an advance invoice
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Issue InvoiceMAXIO_ISSUE_INVOICEAcciónIssues a draft invoice for payment collection. Once issued, the invoice transitions from 'draft' to 'open' state and is ready to collect payment. Use when you need to finalize a draft invoice and initiate the payment process. After issuing, the customer can pay the invoice using the payment URL provided in the response. This action is irreversible - once issued, the invoice cannot be returned to draft state. Note: You can optionally capture prepayments automatically or force issue despite validation warnings.
MAXIO_ISSUE_INVOICEAcciónIssues a draft invoice for payment collection. Once issued, the invoice transitions from 'draft' to 'open' state and is ready to collect payment. Use when you need to finalize a draft invoice and initiate the payment process. After issuing, the customer can pay the invoice using the payment URL provided in the response. This action is irreversible - once issued, the invoice cannot be returned to draft state. Note: You can optionally capture prepayments automatically or force issue despite validation warnings.
Parámetros de entrada
forcebooleanWhen set to true, the invoice will be issued even if there are validation warnings. Use with caution. Defaults to false.
invoice_uidstringObligatorioThe unique identifier of the invoice to issue
capture_prepaymentsbooleanWhen set to true, any available prepayments on the subscription will be automatically applied to the invoice at issue time. Defaults to false.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Issue Service CreditMAXIO_ISSUE_SERVICE_CREDITAcciónIssues 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.
MAXIO_ISSUE_SERVICE_CREDITAcciónIssues 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.
Parámetros de entrada
memostringAn optional description or note for the service credit. This will appear in the transaction history.
amountstringObligatorioThe amount to credit to the subscription's service credit balance as a decimal string (e.g., '10.00'). Must be a positive value.
subscription_idintegerObligatorioThe Chargify subscription ID to which to issue the service credit
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Component Price PointsMAXIO_LIST_ALL_COMPONENT_PRICE_POINTSAcciónLists 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.
MAXIO_LIST_ALL_COMPONENT_PRICE_POINTSAcciónLists 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.
Parámetros de entrada
pageintegerThe page number of results to fetch. By default, the first page of results is displayed. Use this parameter to navigate through pages of results.
includestringInclude additional data in the response. For example, 'currency_prices' to include currency-specific pricing.
per_pageintegerThe number of records to fetch per request. Default is 20, maximum is 200. Values over 200 will be changed to 200.
directionstringenumDirection for sorting results.
ascdescfilter_idsstringFilter price points by specific IDs. Provide as comma-separated values (e.g., '1,2,3').
filter_typestringenumType of component price point.
catalogcustomdefaultfilter_end_datestringFilter price points with timestamp up to and including this date. Format: YYYY-MM-DD. Uses site's time zone.
filter_date_fieldstringenumDate field to filter on.
created_atupdated_atfilter_start_datestringFilter price points with timestamp on or after this date. Format: YYYY-MM-DD. Uses site's time zone.
filter_archived_atstringenumFilter for archived price points.
nullnot_nullfilter_end_datetimestringFilter price points with timestamp up to and including this datetime. Format: YYYY-MM-DD HH:MM:SS. Can include timezone.
filter_start_datetimestringFilter price points with timestamp on or after this datetime. Format: YYYY-MM-DD HH:MM:SS. Can include timezone.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List AllocationsMAXIO_LIST_ALLOCATIONSAcciónLists 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.
MAXIO_LIST_ALLOCATIONSAcciónLists 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.
Parámetros de entrada
pageintegerPage number for pagination (default 1).
per_pageintegerNumber of allocations to return per page (1-200, default 25).
component_idintegerObligatorioThe numeric ID of the component to list allocations for.
subscription_idintegerObligatorioThe numeric ID of the subscription to list allocations for.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Product Price PointsMAXIO_LIST_ALL_PRODUCT_PRICE_POINTSAcciónLists 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.
MAXIO_LIST_ALL_PRODUCT_PRICE_POINTSAcciónLists 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.
Parámetros de entrada
pageintegerThe page number to retrieve. Defaults to 1.
sortstringThe field to sort results by. Valid values include 'created_at', 'updated_at', 'name', or 'id'.
end_datestringFilter records to include only those with a date (specified by date_field) on or before this date. Format: YYYY-MM-DD or ISO 8601.
per_pageintegerThe number of records to return per page. Defaults to 25. Maximum is 200.
directionstringThe sort direction for results. Valid values are 'asc' for ascending or 'desc' for descending.
date_fieldstringThe date field to use for filtering when start_date or end_date is provided. Valid values are 'created_at' or 'updated_at'.
start_datestringFilter records to include only those with a date (specified by date_field) on or after this date. Format: YYYY-MM-DD or ISO 8601.
filter_archivedbooleanFilter results to include only archived (true), non-archived (false), or all (null) price points.
filter_product_idstringFilter results to only include price points belonging to a specific product. Accepts product ID or handle prefixed with 'handle:'.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Chargify.js Public KeysMAXIO_LIST_CHARGIFY_JS_PUBLIC_KEYSAcciónLists 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.
MAXIO_LIST_CHARGIFY_JS_PUBLIC_KEYSAcciónLists 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Component Price PointsMAXIO_LIST_COMPONENT_PRICE_POINTSAcciónLists all price points for a component in Maxio Advanced Billing. Use this action when you need to retrieve all available pricing configurations (such as per-unit, tiered, volume, or stair-step pricing) defined for a component. This is helpful for exploring available price points before creating subscriptions, or for auditing pricing configurations across components.
MAXIO_LIST_COMPONENT_PRICE_POINTSAcciónLists all price points for a component in Maxio Advanced Billing. Use this action when you need to retrieve all available pricing configurations (such as per-unit, tiered, volume, or stair-step pricing) defined for a component. This is helpful for exploring available price points before creating subscriptions, or for auditing pricing configurations across components.
Parámetros de entrada
pageintegerPage number for pagination. Defaults to 1 if not specified.
per_pageintegerNumber of price points to return per page (1-200). Defaults to 25.
component_idintegerObligatorioThe ID of the component for which to list price points.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ComponentsMAXIO_LIST_COMPONENTSAcciónReturns 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.
MAXIO_LIST_COMPONENTSAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination.
per_pageintegerThe number of records to return per page (1-200, default 25).
directionstringenumSort direction for listing results.
ascdescfilter_idsinteger[]Filter by component IDs.
filter_handlestringFilter by component handle (exact match).
filter_handlesstring[]Filter by multiple component handles.
filter_end_datestringFilter components created/updated on or before this date (YYYY-MM-DD format).
filter_date_fieldstringThe date field to filter by. One of: created_at, updated_at.
filter_start_datestringFilter components created/updated on or after this date (YYYY-MM-DD format).
filter_archival_statestringFilter by archival state. One of: not_archived, archived, both.
filter_product_family_idintegerFilter by product family ID.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Components for Product FamilyMAXIO_LIST_COMPONENTS_FOR_PRODUCT_FAMILYAcciónLists 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.
MAXIO_LIST_COMPONENTS_FOR_PRODUCT_FAMILYAcciónLists 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.
Parámetros de entrada
pageintegerThe page number for pagination (1-indexed).
per_pageintegerNumber of records to return per page (1-200, default 25).
product_family_idintegerObligatorioThe Chargify id of the product family whose components to list.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Consolidated Invoice SegmentsMAXIO_LIST_CONSOLIDATED_INVOICE_SEGMENTSAcciónLists 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.
MAXIO_LIST_CONSOLIDATED_INVOICE_SEGMENTSAcciónLists 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.
Parámetros de entrada
invoice_uidstringObligatorioThe unique identifier of the consolidated invoice
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Coupons for Product FamilyMAXIO_LIST_COUPONS_FOR_PRODUCT_FAMILYAcciónLists 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.
MAXIO_LIST_COUPONS_FOR_PRODUCT_FAMILYAcciónLists 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.
Parámetros de entrada
product_family_idintegerObligatorioThe Chargify id of the product family whose coupons to list
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Coupon SubcodesMAXIO_LIST_COUPON_SUBCODESAcciónLists 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.
MAXIO_LIST_COUPON_SUBCODESAcciónLists 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.
Parámetros de entrada
coupon_idintegerObligatorioThe Chargify ID of the coupon whose subcodes should be listed
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Credit NotesMAXIO_LIST_CREDIT_NOTESAcciónReturns 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.
MAXIO_LIST_CREDIT_NOTESAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number to retrieve. Pages start at 1. Use together with per_page for pagination.
statusstringenumFilter credit notes by their status. 'open' returns credit notes available for application, 'closed' returns applied credit notes, 'voided' returns voided credit notes.
openclosedvoidedend_datestringFilter credit notes created on or before this date. Format: YYYY-MM-DD
per_pageintegerThe number of records per page. Defaults to 25 if not specified. Maximum value is 200.
date_fieldstringenumThe 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.
created_atcredit_note_datestart_datestringFilter credit notes created on or after this date. Format: YYYY-MM-DD
end_datetimestringFilter credit notes created at or before this datetime. Format: ISO 8601 datetime (e.g., '2024-12-31T23:59:59Z')
start_datetimestringFilter credit notes created at or after this datetime. Format: ISO 8601 datetime (e.g., '2024-01-01T00:00:00Z')
subscription_idintegerFilter credit notes to a specific subscription ID. The subscription must belong to the authenticated site.
credit_note_numberstringSearch for a specific credit note by its credit note number. Exact match or partial match depending on API behavior.
include_credit_note_componentsbooleanInclude credit note components in the response. When true, returns line item details for each credit note.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List CustomersMAXIO_LIST_CUSTOMERSAcciónReturns 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.
MAXIO_LIST_CUSTOMERSAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination.
per_pageintegerThe number of records to return per page (1-200, default 25).
directionstringenumSort direction for listing results.
ascdescfilter_idsinteger[]Filter by customer IDs.
filter_zipstringFilter by postal/zip code.
filter_statestringFilter by customer state. One of: active, canceled.
filter_end_datestringFilter customers created/updated on or before this date (YYYY-MM-DD format).
filter_referencestringFilter by customer reference (exact match).
filter_date_fieldstringThe date field to filter by. One of: created_at, updated_at.
filter_start_datestringFilter customers created/updated on or after this date (YYYY-MM-DD format).
filter_organizationstringFilter by organization name (exact match or partial match depending on API behavior).
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Customer SubscriptionsMAXIO_LIST_CUSTOMER_SUBSCRIPTIONSAcciónLists 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.
MAXIO_LIST_CUSTOMER_SUBSCRIPTIONSAcciónLists 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.
Parámetros de entrada
pageintegerThe page number to retrieve (default: 1)
statestringenumFilter by subscription state
activecanceledtrialingpausedpast_duetrial_endedcompletedsuspendedexpiredfailedpendinganyincludestringComma-separated list of related resources to include (e.g., 'customer,product')
per_pageintegerThe number of results per page (default: 25, max: 200)
customer_idintegerObligatorioThe Chargify customer ID whose subscriptions to list
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Webhook EndpointsMAXIO_LIST_ENDPOINTSAcciónReturns 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.
MAXIO_LIST_ENDPOINTSAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number for pagination (1-indexed).
per_pageintegerNumber of records to return per page (1-200, default 25).
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List EventsMAXIO_LIST_EVENTSAcciónReturns 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.
MAXIO_LIST_EVENTSAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number for pagination (1-indexed).
sincestringFilter events created on or after this datetime (ISO 8601 format, e.g., '2024-01-01T00:00:00Z').
untilstringFilter events created on or before this datetime (ISO 8601 format, e.g., '2024-12-31T23:59:59Z').
filterstringA filter key to narrow down results. Format depends on the filter type (e.g., 'subscription_id=12345').
per_pageintegerNumber of records to return per page (1-200, default 25).
event_typestringFilter 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Exported InvoicesMAXIO_LIST_EXPORTED_INVOICESAcciónRetrieves a list of exported invoices for a specific invoice export batch. Use this action when you need to fetch the rows (invoice data) from a previously initiated invoice export. The batch_id should be obtained from the export initiation response or from the list of invoice exports. This action supports pagination through the page and per_page parameters. Note: The response is a list of invoice objects containing all invoice details including line items, payments, credits, taxes, and custom fields.
MAXIO_LIST_EXPORTED_INVOICESAcciónRetrieves a list of exported invoices for a specific invoice export batch. Use this action when you need to fetch the rows (invoice data) from a previously initiated invoice export. The batch_id should be obtained from the export initiation response or from the list of invoice exports. This action supports pagination through the page and per_page parameters. Note: The response is a list of invoice objects containing all invoice details including line items, payments, credits, taxes, and custom fields.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through pages of results. If there are no results, an empty result set will be returned.
batch_idstringObligatorioThe unique identifier of the invoice export batch. This is the ID returned when initiating an invoice export.
per_pageintegerNumber of records to fetch per page. Default is 100. Maximum allowed value is 10000; any value over 10000 will be changed to 10000.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Exported Proforma InvoicesMAXIO_LIST_EXPORTED_PROFORMA_INVOICESAcciónLists exported proforma invoice rows from a previously initiated export batch. Use when you need to retrieve the actual data from a proforma invoices export, such as for analysis, reporting, or importing into another system. Note: The batch_id parameter should be the ID returned when the export was initiated using the Export Proforma Invoices action.
MAXIO_LIST_EXPORTED_PROFORMA_INVOICESAcciónLists exported proforma invoice rows from a previously initiated export batch. Use when you need to retrieve the actual data from a proforma invoices export, such as for analysis, reporting, or importing into another system. Note: The batch_id parameter should be the ID returned when the export was initiated using the Export Proforma Invoices action.
Parámetros de entrada
pageintegerPage number of results to fetch. Use for pagination when results span multiple pages.
batch_idstringObligatorioThe unique identifier of the export batch job (returned when initiating the export)
per_pageintegerNumber of records to fetch per page. Default is 100. Maximum allowed value is 10000.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Exported SubscriptionsMAXIO_LIST_EXPORTED_SUBSCRIPTIONSAcciónLists 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.
MAXIO_LIST_EXPORTED_SUBSCRIPTIONSAcciónLists 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.
Parámetros de entrada
pageintegerPage number for pagination. If there are no results, an empty result set will be returned.
batch_idstringObligatorioThe batch ID from the export job. This is the subscription_id returned when creating an export.
per_pageintegerNumber of records to fetch per page. Default is 100. Maximum is 10000.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Invoice EventsMAXIO_LIST_INVOICE_EVENTSAcciónLists all invoice events from Maxio/Chargify with optional filtering. Use this action when you need to retrieve invoice event history, such as tracking invoice status changes (created, paid, voided), monitoring payment activity, or auditing billing events for a specific time period. This action supports date range filtering via start_date and end_date parameters. Results are paginated with a default of 25 events per page.
MAXIO_LIST_INVOICE_EVENTSAcciónLists all invoice events from Maxio/Chargify with optional filtering. Use this action when you need to retrieve invoice event history, such as tracking invoice status changes (created, paid, voided), monitoring payment activity, or auditing billing events for a specific time period. This action supports date range filtering via start_date and end_date parameters. Results are paginated with a default of 25 events per page.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through pages of results.
end_datestringFilter events occurring on or before this date. Format: YYYY-MM-DD
per_pageintegerNumber of records to fetch per page. Default is 25. Maximum allowed value is 200.
start_datestringFilter events occurring on or after this date. Format: YYYY-MM-DD
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List InvoicesMAXIO_LIST_INVOICESAcciónReturns 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.
MAXIO_LIST_INVOICESAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination (1-indexed).
per_pageintegerThe number of records to return per page (1-200, default 25).
directionstringenumSort direction for listing results.
ascdescfilter_idintegerFilter by invoice ID (exact match).
filter_statusstringenumFilter by invoice status. Use 'all' to include all statuses.
draftpendingopenpaidvoidedcanceledallfilter_end_datestringFilter by end date (YYYY-MM-DD format, inclusive).
filter_date_fieldstringThe date field to filter by. One of: issue_date, due_date, created_at, updated_at.
filter_product_idintegerFilter by product ID.
filter_start_datestringFilter by start date (YYYY-MM-DD format, inclusive).
filter_customer_idintegerFilter by customer ID.
filter_subscription_idintegerFilter by subscription ID.
filter_product_family_idintegerFilter by product family ID.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Metadata for Resource TypeMAXIO_LIST_METADATA_FOR_RESOURCE_TYPEAcciónLists 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.
MAXIO_LIST_METADATA_FOR_RESOURCE_TYPEAcciónLists 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.
Parámetros de entrada
pageintegerPage number for pagination (default 1).
per_pageintegerNumber of metadata items to return per page (1-200, default 25).
resource_typestringObligatorioenumThe type of resource to list metadata for. Valid values: customers, subscriptions, sites.
customerssubscriptionssites
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List MetafieldsMAXIO_LIST_METAFIELDSAcciónLists all metafield definitions for a resource type in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all custom field (metafield) definitions configured for a specific resource type such as customers, subscriptions, products, or product families. This helps you understand what custom data fields are available for data entry or reporting purposes. This is a read-only operation that does not modify any data.
MAXIO_LIST_METAFIELDSAcciónLists all metafield definitions for a resource type in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all custom field (metafield) definitions configured for a specific resource type such as customers, subscriptions, products, or product families. This helps you understand what custom data fields are available for data entry or reporting purposes. This is a read-only operation that does not modify any data.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination.
per_pageintegerThe number of records to return per page (1-200, default 25).
resource_typestringObligatorioenumThe type of resource to list metafields for. Valid values: customers, subscriptions, products, product_families.
customerssubscriptionsproductsproduct_families
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List MRR MovementsMAXIO_LIST_MRR_MOVEMENTSAcciónReturns MRR movement history showing changes in Monthly Recurring Revenue. Use this action when you need to retrieve the history of MRR changes for your Chargify site, such as for financial reporting, churn analysis, revenue tracking, or understanding subscription lifecycle metrics. This action supports date range filtering, pagination, sorting, and filtering by subscription, customer, or movement type.
MAXIO_LIST_MRR_MOVEMENTSAcciónReturns MRR movement history showing changes in Monthly Recurring Revenue. Use this action when you need to retrieve the history of MRR changes for your Chargify site, such as for financial reporting, churn analysis, revenue tracking, or understanding subscription lifecycle metrics. This action supports date range filtering, pagination, sorting, and filtering by subscription, customer, or movement type.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination.
end_datestringFilter movements occurring on or before this date (YYYY-MM-DD format).
per_pageintegerThe number of records to return per page (1-200, default 25).
directionstringenumSort direction for listing results.
ascdescstart_datestringFilter movements occurring on or after this date (YYYY-MM-DD format).
filter_date_fieldstringThe date field to filter by. One of: created_at, effective_date.
filter_customer_idintegerFilter by customer ID.
filter_movement_typestringenumTypes of MRR movements.
newactivationreactivationexpansioncontractioncancellationchurndowngradeupgraderefundadjustmentfilter_subscription_idintegerFilter by subscription ID.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List MRR Per SubscriptionMAXIO_LIST_MRR_PER_SUBSCRIPTIONAcciónReturns 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.
MAXIO_LIST_MRR_PER_SUBSCRIPTIONAcciónReturns 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.
Parámetros de entrada
pageintegerResult records are organized in pages. By default, the first page of results is displayed.
at_timestringSubmit a timestamp in ISO8601 format to request MRR for a historic time.
per_pageintegerThis parameter indicates how many records to fetch in each request (1-200, default 25).
directionstringenumSort direction for listing results.
ascdescfilter_subscription_idsinteger[]Submit subscription IDs in order to limit results.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List OffersMAXIO_LIST_OFFERSAcciónReturns 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.
MAXIO_LIST_OFFERSAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination.
per_pageintegerThe number of records to return per page (1-200, default 25).
directionstringenumSort direction for listing results.
ascdescfilter_idsinteger[]Filter by offer IDs.
filter_handlestringFilter by offer handle (exact match).
filter_end_datestringFilter offers created/updated on or before this date (YYYY-MM-DD format).
filter_date_fieldstringThe date field to filter by. One of: created_at, updated_at.
filter_offer_typestringFilter by offer type.
filter_product_idintegerFilter by product ID.
filter_start_datestringFilter offers created/updated on or after this date (YYYY-MM-DD format).
filter_archival_statestringenumFilter for archival state of offers.
not_archivedarchivedbothfilter_subscription_idintegerFilter by subscription ID.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Payment ProfilesMAXIO_LIST_PAYMENT_PROFILESAcciónReturns a list of payment profiles in Maxio Advanced Billing. Use this action when you need to retrieve all payment profiles (credit cards, bank accounts, or other payment methods) for verification, reporting, or administrative purposes. Results can be filtered by customer ID, vault type, and can be paginated for large result sets. This is a read-only operation that does not modify any data.
MAXIO_LIST_PAYMENT_PROFILESAcciónReturns a list of payment profiles in Maxio Advanced Billing. Use this action when you need to retrieve all payment profiles (credit cards, bank accounts, or other payment methods) for verification, reporting, or administrative purposes. Results can be filtered by customer ID, vault type, and can be paginated for large result sets. This is a read-only operation that does not modify any data.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination (default: 1).
includestringComma-separated list of related resources to include (e.g., 'customer').
per_pageintegerThe number of records to return per page (1-200, default 25).
directionstringenumSort direction for listing results.
ascdesccustomer_idintegerFilter payment profiles by customer ID. When provided, only profiles for this customer are returned.
filter_vault_tokenstringFilter by vault token to find profiles stored in an external vault.
filter_current_vaultstringFilter by the current vault where card data is stored. Examples: 'stripe', 'braintree', 'authorizenet'.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List PrepaymentsMAXIO_LIST_PREPAYMENTSAcciónLists all prepayments for a subscription in Maxio Advanced Billing. Use this action when you need to retrieve all prepayments associated with a subscription, including their amounts, payment methods, remaining balances, and application status. This is useful for auditing prepayment history, tracking advance payments, or checking available prepayment balances. This is a read-only operation that does not modify any data.
MAXIO_LIST_PREPAYMENTSAcciónLists all prepayments for a subscription in Maxio Advanced Billing. Use this action when you need to retrieve all prepayments associated with a subscription, including their amounts, payment methods, remaining balances, and application status. This is useful for auditing prepayment history, tracking advance payments, or checking available prepayment balances. This is a read-only operation that does not modify any data.
Parámetros de entrada
pageintegerPage number for pagination (default 1).
per_pageintegerNumber of prepayments to return per page (1-200, default 25).
subscription_idintegerObligatorioThe Chargify subscription ID for which to list prepayments.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Product FamiliesMAXIO_LIST_PRODUCT_FAMILIESAcciónReturns 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.
MAXIO_LIST_PRODUCT_FAMILIESAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination.
per_pageintegerThe number of records to return per page (1-200, default 25).
directionstringenumSort direction for listing results.
ascdescfilter_idsinteger[]Filter by product family IDs.
filter_handlestringFilter by product family handle (exact match).
filter_handlesstring[]Filter by multiple product family handles.
filter_end_datestringFilter product families created/updated on or before this date (YYYY-MM-DD format).
filter_date_fieldstringThe date field to filter by. One of: created_at, updated_at.
filter_start_datestringFilter product families created/updated on or after this date (YYYY-MM-DD format).
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Product Price PointsMAXIO_LIST_PRODUCT_PRICE_POINTSAcciónLists 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.
MAXIO_LIST_PRODUCT_PRICE_POINTSAcciónLists 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.
Parámetros de entrada
pageintegerPage number for pagination. Defaults to 1 if not specified.
per_pageintegerNumber of price points to return per page (1-200). Defaults to 25.
product_idanyObligatorioThe ID or handle of the product to list price points for. When using handle, prefix with 'handle:'.
filter_statusstringFilter by price point status. One of: active, archived, both.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ProductsMAXIO_LIST_PRODUCTSAcciónReturns 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.
MAXIO_LIST_PRODUCTSAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination.
per_pageintegerThe number of records to return per page (1-200, default 25).
directionstringenumSort direction for listing results.
ascdescfilter_idsinteger[]Filter by product IDs.
filter_statestringenumState filter for products.
activearchivedbothfilter_handlestringFilter by product handle (exact match).
filter_handlesstring[]Filter by multiple product handles.
filter_end_datestringFilter products created/updated on or before this date (YYYY-MM-DD format).
filter_date_fieldstringThe date field to filter by. One of: created_at, updated_at.
filter_start_datestringFilter products created/updated on or after this date (YYYY-MM-DD format).
filter_product_family_idintegerFilter by product family ID.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Products for Product FamilyMAXIO_LIST_PRODUCTS_FOR_PRODUCT_FAMILYAcciónLists all products within a product family in Maxio/Chargify. Use when you need to retrieve all subscription products associated with a specific product family, such as for displaying available plans to customers or auditing product offerings. Supports pagination with optional page and per_page parameters to handle large numbers of products efficiently.
MAXIO_LIST_PRODUCTS_FOR_PRODUCT_FAMILYAcciónLists all products within a product family in Maxio/Chargify. Use when you need to retrieve all subscription products associated with a specific product family, such as for displaying available plans to customers or auditing product offerings. Supports pagination with optional page and per_page parameters to handle large numbers of products efficiently.
Parámetros de entrada
pageintegerThe page number for pagination (1-indexed).
per_pageintegerNumber of records to return per page (1-200, default 25).
product_family_idintegerObligatorioThe Chargify id of the product family whose products to list.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Proforma InvoicesMAXIO_LIST_PROFORMA_INVOICESAcciónLists 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.
MAXIO_LIST_PROFORMA_INVOICESAcciónLists 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.
Parámetros de entrada
pageintegerPage number for pagination (default 1)
per_pageintegerNumber of proforma invoices to return per page (1-200, default 25)
subscription_idintegerObligatorioThe numeric ID of the subscription to list proforma invoices for
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Reason CodesMAXIO_LIST_REASON_CODESAcciónReturns 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.
MAXIO_LIST_REASON_CODESAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination.
per_pageintegerThe number of records to return per page (1-200, default 25).
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Service CreditsMAXIO_LIST_SERVICE_CREDITSAcciónLists all service credits for a subscription in Maxio Advanced Billing. Use this action when you need to retrieve all service credits associated with a subscription, including their amounts, memos, and creation timestamps. This is useful for auditing service credit history, tracking promotional credits, or checking the available service credit balance. This is a read-only operation that does not modify any data.
MAXIO_LIST_SERVICE_CREDITSAcciónLists all service credits for a subscription in Maxio Advanced Billing. Use this action when you need to retrieve all service credits associated with a subscription, including their amounts, memos, and creation timestamps. This is useful for auditing service credit history, tracking promotional credits, or checking the available service credit balance. This is a read-only operation that does not modify any data.
Parámetros de entrada
pageintegerPage number for pagination (default 1).
per_pageintegerNumber of service credits to return per page (1-200, default 25).
subscription_idintegerObligatorioThe Chargify subscription ID for which to list service credits.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Subscription ComponentsMAXIO_LIST_SUBSCRIPTION_COMPONENTSAcciónLists 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.
MAXIO_LIST_SUBSCRIPTION_COMPONENTSAcciónLists 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.
Parámetros de entrada
pageintegerPage number for pagination (default 1).
per_pageintegerNumber of records to return per page (1-200, default 25).
subscription_idintegerObligatorioThe numeric ID of the subscription whose components to list.
filter_component_idintegerFilter by a specific component ID.
filter_price_point_idintegerFilter by a specific price point ID.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Subscription Components For SiteMAXIO_LIST_SUBSCRIPTION_COMPONENTS_FOR_SITEAcciónLists 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.
MAXIO_LIST_SUBSCRIPTION_COMPONENTS_FOR_SITEAcciónLists 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.
Parámetros de entrada
pageintegerPage number for pagination (default 1).
sortstringThe attribute by which to sort results.
includestringInclude additional data in the response. Use 'subscription' to include subscription details.
end_datestringFilter components by date on or before this date (YYYY-MM-DD format).
per_pageintegerNumber of records to return per page (1-200, default 25).
directionstringenumSort direction for listing results.
ascdescdate_fieldstringThe type of filter to apply to the search. One of: created_at, updated_at.
start_datestringFilter components by date on or after this date (YYYY-MM-DD format).
end_datetimestringFilter components by datetime on or before this time (YYYY-MM-DD HH:MM:SS format). If provided, this takes precedence over end_date.
start_datetimestringFilter components by datetime on or after this time (YYYY-MM-DD HH:MM:SS format). If provided, this takes precedence over start_date.
price_point_idsinteger[]Filter components by price point IDs.
subscription_idsinteger[]Filter components by subscription IDs.
filter_currenciesstringFilter components by currency codes (comma-separated).
product_family_idsinteger[]Filter components by product family IDs.
filter_subscription_statesstringFilter components by subscription states. To use this filter, include 'subscription' in the 'include' parameter.
filter_subscription_end_datestringFilter components belonging to subscriptions created/updated on or before this date (YYYY-MM-DD). To use this filter, include 'subscription' in the 'include' parameter.
filter_use_site_exchange_ratebooleanFilter components by whether they use the site's exchange rate.
filter_subscription_date_fieldstringThe date field type to filter subscriptions by. To use this filter, include 'subscription' in the 'include' parameter.
filter_subscription_start_datestringFilter components belonging to subscriptions created/updated on or after this date (YYYY-MM-DD). To use this filter, include 'subscription' in the 'include' parameter.
filter_subscription_end_datetimestringFilter 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.
filter_subscription_start_datetimestringFilter 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Subscription EventsMAXIO_LIST_SUBSCRIPTION_EVENTSAcciónReturns 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.
MAXIO_LIST_SUBSCRIPTION_EVENTSAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number for pagination (1-indexed).
per_pageintegerNumber of records to return per page (1-200, default 25).
since_idintegerReturn only events with ID greater than or equal to the specified ID. Use for pagination to avoid duplicates when scrolling through many results.
until_idintegerReturn only events with ID less than or equal to the specified ID. Use for pagination to limit results to a specific range.
directionstringenumThe direction to sort events: 'asc' for ascending (oldest first) or 'desc' for descending (newest first).
ascdescsubscription_idintegerObligatorioThe numeric ID of the subscription to list events for.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Subscription GroupsMAXIO_LIST_SUBSCRIPTION_GROUPSAcciónReturns 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.
MAXIO_LIST_SUBSCRIPTION_GROUPSAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination.
per_pageintegerThe number of records to return per page (1-200, default 25).
directionstringenumSort direction for listing results.
ascdescfilter_idsinteger[]Filter by subscription group IDs.
filter_statestringenumState filter for subscription groups.
activepast_duecanceledsubscriber_initiatedadministrator_initiatedfilter_end_datestringFilter subscription groups created/updated on or before this date (YYYY-MM-DD format).
filter_date_fieldstringThe date field to filter by. One of: created_at, updated_at.
filter_start_datestringFilter subscription groups created/updated on or after this date (YYYY-MM-DD format).
filter_customer_idintegerFilter by customer ID.
filter_subscription_idintegerFilter by subscription ID.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Subscription NotesMAXIO_LIST_SUBSCRIPTION_NOTESAcciónLists all notes attached to a subscription in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all notes for a specific subscription, such as viewing customer communication history, auditing support interactions, or retrieving billing-related information stored on a subscription. This is a read-only operation that does not modify any data.
MAXIO_LIST_SUBSCRIPTION_NOTESAcciónLists all notes attached to a subscription in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all notes for a specific subscription, such as viewing customer communication history, auditing support interactions, or retrieving billing-related information stored on a subscription. This is a read-only operation that does not modify any data.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination.
per_pageintegerThe number of records to return per page (1-200, default 25).
subscription_idintegerObligatorioThe Chargify id of the subscription
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SubscriptionsMAXIO_LIST_SUBSCRIPTIONSAcciónReturns a list of subscriptions with optional filtering and pagination. Use this action when you need to retrieve all subscriptions from your Chargify/Maxio billing system. Supports pagination and filtering by date range, subscription state, customer IDs, product IDs, coupon codes, offer ID, trial status, billing interval, and subscription group. This is a read-only operation that does not modify any data.
MAXIO_LIST_SUBSCRIPTIONSAcciónReturns a list of subscriptions with optional filtering and pagination. Use this action when you need to retrieve all subscriptions from your Chargify/Maxio billing system. Supports pagination and filtering by date range, subscription state, customer IDs, product IDs, coupon codes, offer ID, trial status, billing interval, and subscription group. This is a read-only operation that does not modify any data.
Parámetros de entrada
pageintegerThe page number to retrieve for pagination.
sortstringField to sort by (e.g., 'created_at', 'updated_at', 'state').
per_pageintegerThe number of records to return per page (1-200, default 25).
directionstringenumSort direction for listing results.
ascdescfilter_idsinteger[]Filter by subscription IDs.
filter_statestringenumSubscription state filter values.
activecanceledtrialingpausedpast_duetrial_endedcompletedsuspendedexpiredfailedpendinganyfilter_end_datestringFilter subscriptions created/updated on or before this date (YYYY-MM-DD format).
filter_offer_idintegerFilter by offer ID.
filter_on_trialbooleanFilter to include only subscriptions that are currently on trial.
filter_date_fieldstringThe date field to filter by. One of: created_at, updated_at, activated_at, canceled_at.
filter_start_datestringFilter subscriptions created/updated on or after this date (YYYY-MM-DD format).
filter_product_idsinteger[]Filter by product IDs.
filter_coupon_codesstring[]Filter by coupon codes.
filter_customer_idsinteger[]Filter by customer IDs.
filter_plan_intervalstringFilter by billing interval. One of: day, week, month, year.
filter_subscription_group_idintegerFilter by subscription group ID.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List UsagesMAXIO_LIST_USAGESAcciónLists all usage records for a component on a subscription. Use this action when you need to retrieve the usage history for a metered or prepaid component attached to a subscription. This is useful for auditing usage, reviewing overage charges, or understanding consumption patterns. The response includes details such as quantity recorded, memo, timestamps, and remaining unit balance for each usage record.
MAXIO_LIST_USAGESAcciónLists all usage records for a component on a subscription. Use this action when you need to retrieve the usage history for a metered or prepaid component attached to a subscription. This is useful for auditing usage, reviewing overage charges, or understanding consumption patterns. The response includes details such as quantity recorded, memo, timestamps, and remaining unit balance for each usage record.
Parámetros de entrada
pageintegerPage number for pagination (default 1).
per_pageintegerNumber of usages to return per page (1-200, default 25).
component_idintegerObligatorioThe numeric ID of the component to list usages for.
subscription_idintegerObligatorioThe numeric ID of the subscription to list usages for.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List WebhooksMAXIO_LIST_WEBHOOKSAcciónReturns 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.
MAXIO_LIST_WEBHOOKSAcciónReturns 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.
Parámetros de entrada
pageintegerThe page number for pagination (1-indexed).
per_pageintegerNumber of records to return per page (1-200, default 25).
filter_activebooleanFilter webhooks by active status. When true, returns only active webhooks.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Migrate Subscription ProductMAXIO_MIGRATE_SUBSCRIPTION_PRODUCTAcciónMigrates 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.
MAXIO_MIGRATE_SUBSCRIPTION_PRODUCTAcciónMigrates 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.
Parámetros de entrada
product_idintegerObligatorioThe numeric ID of the product to migrate the subscription to
subscription_idintegerObligatorioThe numeric ID of the subscription to migrate to a different product
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Override SubscriptionMAXIO_OVERRIDE_SUBSCRIPTIONAcciónOverrides 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.
MAXIO_OVERRIDE_SUBSCRIPTIONAcciónOverrides 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.
Parámetros de entrada
subscription_idintegerObligatorioThe numeric ID of the subscription to override
cancellation_messagestringA message explaining the cancellation override
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Promote Product Price Point to DefaultMAXIO_PATCH_PRODUCT_PRICE_POINT_TO_DEFAULTAcciónPromotes 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.
MAXIO_PATCH_PRODUCT_PRICE_POINT_TO_DEFAULTAcciónPromotes 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.
Parámetros de entrada
product_idanyObligatorioThe ID or handle of the product. When using the handle, it must be prefixed with `handle:`
price_point_idanyObligatorioThe ID or handle of the price point to promote to default. When using the handle, it must be prefixed with `handle:`
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Pause SubscriptionMAXIO_PAUSE_SUBSCRIPTIONAcciónPauses 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').
MAXIO_PAUSE_SUBSCRIPTIONAcciónPauses 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').
Parámetros de entrada
subscription_idintegerObligatorioThe numeric ID of the subscription to pause
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview AllocationsMAXIO_PREVIEW_ALLOCATIONSAcciónPreviews 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.
MAXIO_PREVIEW_ALLOCATIONSAcciónPreviews 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.
Parámetros de entrada
allocationsobject[]ObligatorioArray of allocation preview items. Each item specifies the component and quantity to preview.
subscription_idintegerObligatorioThe numeric ID of the subscription to preview allocations for.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview Customer Information ChangesMAXIO_PREVIEW_CUSTOMER_INFORMATION_CHANGESAcciónPreviews customer information changes for an invoice. This endpoint shows what the invoice would look like with updated customer information before the changes are actually applied. Use when you need to preview how changes to customer details (such as billing address, shipping address, or organization name) would appear on an invoice. This allows you to verify the changes before committing them. Note: This action does not modify any data. It only returns a preview of what the customer information would look like if updated.
MAXIO_PREVIEW_CUSTOMER_INFORMATION_CHANGESAcciónPreviews customer information changes for an invoice. This endpoint shows what the invoice would look like with updated customer information before the changes are actually applied. Use when you need to preview how changes to customer details (such as billing address, shipping address, or organization name) would appear on an invoice. This allows you to verify the changes before committing them. Note: This action does not modify any data. It only returns a preview of what the customer information would look like if updated.
Parámetros de entrada
invoice_uidstringObligatorioThe unique identifier of the invoice
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview Proforma InvoiceMAXIO_PREVIEW_PROFORMA_INVOICEAcciónPreviews 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.
MAXIO_PREVIEW_PROFORMA_INVOICEAcciónPreviews 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.
Parámetros de entrada
subscription_idintegerObligatorioThe numeric ID of the subscription to preview a proforma invoice for
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview RenewalMAXIO_PREVIEW_RENEWALAcciónPreviews 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.
MAXIO_PREVIEW_RENEWALAcciónPreviews 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.
Parámetros de entrada
include_trialbooleanWhether to include trial amounts in the renewal preview. Defaults to false.
subscription_idintegerObligatorioThe numeric ID of the subscription to preview renewal charges for
include_setup_feesbooleanWhether to include setup fees in the renewal preview. Defaults to false.
include_next_chargebooleanWhether to include the next charge amount in the preview. Defaults to true.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview Signup Proforma InvoiceMAXIO_PREVIEW_SIGNUP_PROFORMA_INVOICEAcciónPreviews a proforma invoice for signup. A proforma invoice shows the expected charges for a new subscription before it is actually created. Use this action when you need to preview billing amounts for a potential new customer or to share expected costs before finalizing a subscription signup. This action requires a product_handle and customer_attributes (first_name, last_name, and email are required). The response contains the complete proforma invoice details including line items, amounts, and due dates.
MAXIO_PREVIEW_SIGNUP_PROFORMA_INVOICEAcciónPreviews a proforma invoice for signup. A proforma invoice shows the expected charges for a new subscription before it is actually created. Use this action when you need to preview billing amounts for a potential new customer or to share expected costs before finalizing a subscription signup. This action requires a product_handle and customer_attributes (first_name, last_name, and email are required). The response contains the complete proforma invoice details including line items, amounts, and due dates.
Parámetros de entrada
product_handlestringObligatorioThe handle of the product/pricing plan to preview
customer_attributesobjectObligatorioCustomer information for the signup preview
payment_collection_methodstringPayment collection method (e.g., 'automatic', 'reminder')
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview SubscriptionMAXIO_PREVIEW_SUBSCRIPTIONAcciónPreviews 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.
MAXIO_PREVIEW_SUBSCRIPTIONAcciónPreviews 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.
Parámetros de entrada
net_termsintegerNumber of days until the subscription invoice is due (0 = immediate)
po_numberstringPurchase order number for the subscription
trial_endstringDate/time to end the trial period (ISO 8601 format, e.g., '2024-12-01T00:00:00Z')
componentsobject[]Component allocation settings as list of component configurations
product_idintegerThe ID of the product (required if product_handle not provided)
customer_idintegerThe ID of an existing customer to associate with this subscription (required if not providing customer attributes)
vault_tokenstringToken from a payment vault for an already stored payment method
coupon_codesstring[]List of coupon codes to apply to the subscription
current_vaultstringThe vault where the card is stored (e.g., 'stripe', 'braintree', 'authorizenet')
custom_fieldsobject[]Custom field values as list of name/value objects
payment_tokenstringA tokenized payment method from a payment gateway (e.g., 'tok_visa')
referral_codestringReferral code to apply to the subscription
product_handlestringThe handle of the product (required if product_id not provided)
payment_profile_idintegerThe ID of an existing payment profile to use for billing
customer_attributesobjectCustomer attributes for inline customer creation in the preview.
credit_card_attributesobjectCredit card attributes for direct card entry.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview Subscription Product MigrationMAXIO_PREVIEW_SUBSCRIPTION_PRODUCT_MIGRATIONAcciónPreviews 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.
MAXIO_PREVIEW_SUBSCRIPTION_PRODUCT_MIGRATIONAcciónPreviews 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.
Parámetros de entrada
product_idintegerThe current product ID of the subscription (optional, will be looked up if not provided)
include_childbooleanWhether to include migrated child subscriptions in the preview
new_product_idintegerObligatorioThe numeric ID of the product to migrate the subscription to
subscription_idintegerObligatorioThe numeric ID of the subscription to preview migration for
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Promote Component Price Point to DefaultMAXIO_PROMOTE_COMPONENT_PRICE_POINT_TO_DEFAULTAcciónPromotes 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.
MAXIO_PROMOTE_COMPONENT_PRICE_POINT_TO_DEFAULTAcciónPromotes 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.
Parámetros de entrada
component_idintegerObligatorioThe ID of the component that owns the price point to promote.
price_point_idintegerObligatorioThe ID of the price point to promote to default.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reactivate SubscriptionMAXIO_REACTIVATE_SUBSCRIPTIONAcciónReactivates 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.
MAXIO_REACTIVATE_SUBSCRIPTIONAcciónReactivates 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.
Parámetros de entrada
subscription_idintegerObligatorioThe numeric ID of the subscription to reactivate
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reactivate Subscription GroupMAXIO_REACTIVATE_SUBSCRIPTION_GROUPAcciónReactivates 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.
MAXIO_REACTIVATE_SUBSCRIPTION_GROUPAcciónReactivates 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.
Parámetros de entrada
uidstringObligatorioThe unique identifier of the subscription group to reactivate. This is the uid from the subscription group object, not the numeric id.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Account BalancesMAXIO_READ_ACCOUNT_BALANCESAcciónRetrieves 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.
MAXIO_READ_ACCOUNT_BALANCESAcciónRetrieves 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.
Parámetros de entrada
subscription_idintegerObligatorioThe Chargify subscription ID for which to retrieve account balances.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Advance InvoiceMAXIO_READ_ADVANCE_INVOICEAcciónRetrieves 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.
MAXIO_READ_ADVANCE_INVOICEAcciónRetrieves 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.
Parámetros de entrada
subscription_idintegerObligatorioThe ID of the subscription for which to retrieve the advance invoice
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read ComponentMAXIO_READ_COMPONENTAcciónRetrieves 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.
MAXIO_READ_COMPONENTAcciónRetrieves 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.
Parámetros de entrada
component_idstringObligatorioEither the Chargify id of the component or the handle for the component prefixed with `handle:`.
product_family_idintegerObligatorioThe Chargify id of the product family to which the component belongs.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Component by HandleMAXIO_READ_COMPONENT_BY_HANDLEAcciónFinds 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.
MAXIO_READ_COMPONENT_BY_HANDLEAcciónFinds 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.
Parámetros de entrada
handlestringObligatorioThe unique handle used to identify the component.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Component Price PointMAXIO_READ_COMPONENT_PRICE_POINTAcciónRetrieves 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.
MAXIO_READ_COMPONENT_PRICE_POINTAcciónRetrieves 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.
Parámetros de entrada
component_idintegerObligatorioThe ID of the component that owns the price point.
price_point_idintegerObligatorioThe ID of the price point to retrieve.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read CouponMAXIO_READ_COUPONAcciónRetrieves 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.
MAXIO_READ_COUPONAcciónRetrieves 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.
Parámetros de entrada
coupon_idintegerObligatorioThe Chargify id of the coupon
product_family_idintegerObligatorioThe Chargify id of the product family to which the coupon belongs
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Find Coupon by CodeMAXIO_READ_COUPON_BY_CODEAcciónFinds 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.
MAXIO_READ_COUPON_BY_CODEAcciónFinds 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.
Parámetros de entrada
codestringObligatorioThe unique coupon code to search for
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Coupon UsageMAXIO_READ_COUPON_USAGEAcciónRetrieves 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.
MAXIO_READ_COUPON_USAGEAcciónRetrieves 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.
Parámetros de entrada
coupon_idintegerObligatorioThe Chargify id of the coupon to retrieve usage for
product_family_idintegerObligatorioThe Chargify id of the product family that owns the coupon
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Credit NoteMAXIO_READ_CREDIT_NOTEAcciónRetrieves 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
MAXIO_READ_CREDIT_NOTEAcciónRetrieves 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
Parámetros de entrada
uidstringObligatorioThe unique identifier of the credit note (e.g., 'cn_c4rkvt4hqd8d2')
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read CustomerMAXIO_READ_CUSTOMERAcciónRetrieves 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.
MAXIO_READ_CUSTOMERAcciónRetrieves 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.
Parámetros de entrada
customer_idintegerObligatorioThe Chargify id of the customer
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Customer By ReferenceMAXIO_READ_CUSTOMER_BY_REFERENCEAcciónLooks 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.
MAXIO_READ_CUSTOMER_BY_REFERENCEAcciónLooks 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.
Parámetros de entrada
referencestringObligatorioThe customer's reference value (external identifier)
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Events CountMAXIO_READ_EVENTS_COUNTAcciónReturns 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.
MAXIO_READ_EVENTS_COUNTAcciónReturns 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.
Parámetros de entrada
sincestringFilter events created on or after this datetime (ISO 8601 format, e.g., '2024-01-01T00:00:00Z').
untilstringFilter events created on or before this datetime (ISO 8601 format, e.g., '2024-12-31T23:59:59Z').
filterstringA filter key to narrow down results. Format depends on the filter type (e.g., 'subscription_id=12345').
event_typestringFilter 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read InvoiceMAXIO_READ_INVOICEAcciónRetrieves 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.
MAXIO_READ_INVOICEAcciónRetrieves 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.
Parámetros de entrada
uidstringObligatorioThe unique identifier of the invoice to retrieve
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Invoices Export StatusMAXIO_READ_INVOICES_EXPORTAcciónRetrieves 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.
MAXIO_READ_INVOICES_EXPORTAcciónRetrieves 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.
Parámetros de entrada
batch_idstringObligatorioThe unique identifier of the invoice export batch job. This is the ID returned when initiating an invoice export.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read OfferMAXIO_READ_OFFERAcciónRetrieves 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.
MAXIO_READ_OFFERAcciónRetrieves 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.
Parámetros de entrada
offer_idintegerObligatorioThe Chargify id of the offer to retrieve.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Payment ProfileMAXIO_READ_PAYMENT_PROFILEAcciónRetrieves 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.
MAXIO_READ_PAYMENT_PROFILEAcciónRetrieves 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.
Parámetros de entrada
payment_profile_idintegerObligatorioThe Chargify id of the payment profile to retrieve
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read ProductMAXIO_READ_PRODUCTAcciónRetrieves 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.
MAXIO_READ_PRODUCTAcciónRetrieves 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.
Parámetros de entrada
product_idintegerObligatorioThe Chargify id of the product to retrieve.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Product By HandleMAXIO_READ_PRODUCT_BY_HANDLEAcciónRetrieves 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.
MAXIO_READ_PRODUCT_BY_HANDLEAcciónRetrieves 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.
Parámetros de entrada
api_handlestringObligatorioThe unique handle identifier for the product. This is a URL-friendly string that identifies the product.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Product FamilyMAXIO_READ_PRODUCT_FAMILYAcciónRetrieves 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.
MAXIO_READ_PRODUCT_FAMILYAcciónRetrieves 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.
Parámetros de entrada
product_family_idintegerObligatorioThe Chargify id of the product family
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Product Price PointMAXIO_READ_PRODUCT_PRICE_POINTAcciónRetrieves 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.
MAXIO_READ_PRODUCT_PRICE_POINTAcciónRetrieves 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.
Parámetros de entrada
product_idanyObligatorioThe ID or handle of the product. When using the handle, prefix with 'handle:'.
price_point_idanyObligatorioThe ID or handle of the price point to retrieve. When using the handle, prefix with 'handle:'.
currency_pricesbooleanWhen 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Proforma InvoiceMAXIO_READ_PROFORMA_INVOICEAcciónRetrieves 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.
MAXIO_READ_PROFORMA_INVOICEAcciónRetrieves 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.
Parámetros de entrada
proforma_invoice_uidstringObligatorioThe unique identifier of the proforma invoice to retrieve
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Proforma Invoices ExportMAXIO_READ_PROFORMA_INVOICES_EXPORTAcciónRetrieves 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.
MAXIO_READ_PROFORMA_INVOICES_EXPORTAcciónRetrieves 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.
Parámetros de entrada
batch_idstringObligatorioThe unique identifier of the export batch job (returned when initiating the export)
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Reason CodeMAXIO_READ_REASON_CODEAcciónRetrieves 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.
MAXIO_READ_REASON_CODEAcciónRetrieves 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.
Parámetros de entrada
reason_code_idintegerObligatorioThe Chargify id of the reason code
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read SiteMAXIO_READ_SITEAcciónRetrieves 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.
MAXIO_READ_SITEAcciónRetrieves 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Site StatsMAXIO_READ_SITE_STATSAcciónReturns 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.
MAXIO_READ_SITE_STATSAcciónReturns 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read SubscriptionMAXIO_READ_SUBSCRIPTIONAcciónRetrieves 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.
MAXIO_READ_SUBSCRIPTIONAcciónRetrieves 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.
Parámetros de entrada
includestringAllows including additional data in the response (e.g., 'customer,product,payment_profile')
subscription_idintegerObligatorioThe Chargify id of the subscription to retrieve
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Subscription By ReferenceMAXIO_READ_SUBSCRIPTION_BY_REFERENCEAcciónFinds 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.
MAXIO_READ_SUBSCRIPTION_BY_REFERENCEAcciónFinds 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.
Parámetros de entrada
referencestringObligatorioThe external reference identifier to look up the subscription
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Subscription ComponentMAXIO_READ_SUBSCRIPTION_COMPONENTAcciónRetrieves 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.
MAXIO_READ_SUBSCRIPTION_COMPONENTAcciónRetrieves 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.
Parámetros de entrada
component_idintegerObligatorioThe Chargify id of the component. Alternatively, the component's handle prefixed by `handle:`.
subscription_idintegerObligatorioThe Chargify id of the subscription.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Subscription NoteMAXIO_READ_SUBSCRIPTION_NOTEAcciónRetrieves 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.
MAXIO_READ_SUBSCRIPTION_NOTEAcciónRetrieves 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.
Parámetros de entrada
note_idintegerObligatorioThe Chargify id of the note to retrieve
subscription_idintegerObligatorioThe Chargify id of the subscription associated with the note
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Subscriptions Export StatusMAXIO_READ_SUBSCRIPTIONS_EXPORTAcciónRetrieves 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.
MAXIO_READ_SUBSCRIPTIONS_EXPORTAcciónRetrieves 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.
Parámetros de entrada
batch_idstringObligatorioThe unique identifier of the subscription export batch job. This is the ID returned when initiating a subscription export.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Bulk Record EventsMAXIO_RECORD_BULK_EVENTSAcciónTool to record multiple billable events in bulk for a subscription component. Use when you need to log several usage events at once, such as batch processing usage data or recording multiple overage events. Each event can specify its own quantity and memo. Maximum 1000 events per request.
MAXIO_RECORD_BULK_EVENTSAcciónTool to record multiple billable events in bulk for a subscription component. Use when you need to log several usage events at once, such as batch processing usage data or recording multiple overage events. Each event can specify its own quantity and memo. Maximum 1000 events per request.
Parámetros de entrada
eventsobject[]ObligatorioArray of events to record. Each event specifies quantity, memo, and optional recorded_at timestamp.
component_idintegerObligatorioThe numeric ID of the metered component to record events against.
subscription_idintegerObligatorioThe numeric ID of the subscription to record events for.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Record Payment for InvoiceMAXIO_RECORD_PAYMENT_FOR_INVOICEAcciónRecords 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.
MAXIO_RECORD_PAYMENT_FOR_INVOICEAcciónRecords 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.
Parámetros de entrada
memostringAn optional description or note for the payment that will appear on the invoice
amountstringObligatorioThe payment amount as a decimal string (e.g., '10.00'). This represents the amount being paid for the invoice.
invoice_uidstringObligatorioThe unique identifier of the invoice to record a payment for
receiptAmountstringThe 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.
externalCardIdstringThe external card ID for the payment. If not specified, the default payment profile for the subscription will be used. Format depends on your gateway.
payment_methodstringThe 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'.
paymentProfileIdintegerThe internal ID of the payment profile to use for the payment. If not specified, the default payment profile for the subscription will be used.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Refund InvoiceMAXIO_REFUND_INVOICEAcciónCreates 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.
MAXIO_REFUND_INVOICEAcciónCreates 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.
Parámetros de entrada
uidstringObligatorioThe unique identifier of the invoice to refund
memostringAn optional memo or note to attach to the refund transaction.
amountstringObligatorioThe refund amount as a decimal string (e.g., '5.00'). Must be less than or equal to the invoice's paid amount.
reasonstringObligatorioThe reason for the refund. This will be recorded in the transaction history.
payment_idintegerThe 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.
external_paymentbooleanSet to true if the refund was made outside of the normal payment gateway. Defaults to false.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Refund PrepaymentMAXIO_REFUND_PREPAYMENTAcciónRefunds 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.
MAXIO_REFUND_PREPAYMENTAcciónRefunds 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.
Parámetros de entrada
memostringObligatorioA description or note for the refund. This will appear in the transaction history.
amountstringThe amount to refund as a decimal string (e.g., '10.00'). Either `amount` or `amount_in_cents` must be provided, but not both.
externalbooleanWhether 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.
prepayment_idintegerObligatorioThe ID of the prepayment to refund
amount_in_centsintegerThe amount to refund in cents (e.g., 1000 for $10.00). Either `amount` or `amount_in_cents` must be provided, but not both.
subscription_idintegerObligatorioThe Chargify subscription ID that owns the prepayment to refund
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove Coupon from SubscriptionMAXIO_REMOVE_COUPON_FROM_SUBSCRIPTIONAcciónRemoves an applied coupon from a subscription in Maxio (Chargify) Advanced Billing. Use when you need to remove a promotional discount from an existing subscription and restore regular pricing. This action is irreversible — the coupon will be permanently removed from the subscription and cannot be recovered without reapplying it. Note: If multiple coupons are applied to the subscription, all coupons will be removed. The subscription will then be billed at its regular product price.
MAXIO_REMOVE_COUPON_FROM_SUBSCRIPTIONAcciónRemoves an applied coupon from a subscription in Maxio (Chargify) Advanced Billing. Use when you need to remove a promotional discount from an existing subscription and restore regular pricing. This action is irreversible — the coupon will be permanently removed from the subscription and cannot be recovered without reapplying it. Note: If multiple coupons are applied to the subscription, all coupons will be removed. The subscription will then be billed at its regular product price.
Parámetros de entrada
subscription_idintegerObligatorioThe numeric ID of the subscription from which to remove the coupon
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove Subscription from GroupMAXIO_REMOVE_SUBSCRIPTION_FROM_GROUPAcciónRemoves 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.
MAXIO_REMOVE_SUBSCRIPTION_FROM_GROUPAcciónRemoves 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.
Parámetros de entrada
subscription_idintegerObligatorioThe Chargify id of the subscription to remove from its group
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reopen InvoiceMAXIO_REOPEN_INVOICEAcciónReopens 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.
MAXIO_REOPEN_INVOICEAcciónReopens 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.
Parámetros de entrada
uidstringObligatorioThe unique identifier of the invoice to reopen
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Replay WebhooksMAXIO_REPLAY_WEBHOOKSAcciónReplays specified webhook deliveries in Maxio Advanced Billing. Use this action when you need to resend webhooks that may have failed, were not delivered, or need to be resent for any reason. Provide a list of webhook IDs to replay their corresponding events. This action is idempotent — calling it with the same webhook IDs will resend the same webhooks again.
MAXIO_REPLAY_WEBHOOKSAcciónReplays specified webhook deliveries in Maxio Advanced Billing. Use this action when you need to resend webhooks that may have failed, were not delivered, or need to be resent for any reason. Provide a list of webhook IDs to replay their corresponding events. This action is idempotent — calling it with the same webhook IDs will resend the same webhooks again.
Parámetros de entrada
webhook_idsinteger[]ObligatorioAn 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.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Bulk Reset Subscription Components Price PointsMAXIO_RESET_SUBSCRIPTION_COMPONENTS_PRICE_POINTSAcciónResets 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.
MAXIO_RESET_SUBSCRIPTION_COMPONENTS_PRICE_POINTSAcciónResets 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.
Parámetros de entrada
component_idsinteger[]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.
subscription_idintegerObligatorioThe unique identifier of the subscription whose component price points should be reset.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Resume SubscriptionMAXIO_RESUME_SUBSCRIPTIONAcciónResumes 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.
MAXIO_RESUME_SUBSCRIPTIONAcciónResumes 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.
Parámetros de entrada
subscription_idintegerObligatorioThe numeric ID of the subscription to resume
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retry SubscriptionMAXIO_RETRY_SUBSCRIPTIONAcciónRetries 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.
MAXIO_RETRY_SUBSCRIPTIONAcciónRetries 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.
Parámetros de entrada
subscription_idintegerObligatorioThe numeric ID of the subscription to retry payment for
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Revoke Billing Portal AccessMAXIO_REVOKE_BILLING_PORTAL_ACCESSAcciónRevokes 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.
MAXIO_REVOKE_BILLING_PORTAL_ACCESSAcciónRevokes 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.
Parámetros de entrada
customer_idintegerObligatorioThe Chargify id of the customer for whom to revoke portal access
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Send InvoiceMAXIO_SEND_INVOICEAcciónSends 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.
MAXIO_SEND_INVOICEAcciónSends 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.
Parámetros de entrada
uidstringObligatorioThe unique identifier of the invoice to send
recipient_emailsstring[]Optional list of email addresses to send the invoice to. If not provided, the default recipient(s) from the invoice will be used.
cc_recipient_emailsstring[]Optional list of email addresses to CC on the invoice delivery
bcc_recipient_emailsstring[]Optional list of email addresses to BCC on the invoice delivery
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Send Request Update Payment EmailMAXIO_SEND_REQUEST_UPDATE_PAYMENT_EMAILAcciónSends 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.
MAXIO_SEND_REQUEST_UPDATE_PAYMENT_EMAILAcciónSends 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.
Parámetros de entrada
subscription_idintegerObligatorioThe Chargify id of the subscription for which to request a payment profile update
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unarchive Component Price PointMAXIO_UNARCHIVE_COMPONENT_PRICE_POINTAcciónUnarchives 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.
MAXIO_UNARCHIVE_COMPONENT_PRICE_POINTAcciónUnarchives 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.
Parámetros de entrada
component_idintegerObligatorioThe Chargify id of the component to which the price point belongs
price_point_idintegerObligatorioThe Chargify id of the price point to unarchive
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unarchive OfferMAXIO_UNARCHIVE_OFFERAcciónUnarchives 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.
MAXIO_UNARCHIVE_OFFERAcciónUnarchives 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.
Parámetros de entrada
offer_idintegerObligatorioThe Chargify id of the offer to unarchive
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Unarchive product price pointMAXIO_UNARCHIVE_PRODUCT_PRICE_POINTAcciónUnarchives 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.
MAXIO_UNARCHIVE_PRODUCT_PRICE_POINTAcciónUnarchives 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.
Parámetros de entrada
product_idstringObligatorioThe id or handle of the product. When using the handle, it must be prefixed with `handle:`
price_point_idstringObligatorioThe id or handle of the price point. When using the handle, it must be prefixed with `handle:`
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Automatic Subscription ResumptionMAXIO_UPDATE_AUTOMATIC_SUBSCRIPTION_RESUMPTIONAcciónUpdates 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.
MAXIO_UPDATE_AUTOMATIC_SUBSCRIPTION_RESUMPTIONAcciónUpdates 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.
Parámetros de entrada
subscription_idintegerObligatorioThe numeric ID of the subscription for which to update automatic resumption
automatic_resumptionbooleanObligatorioWhen 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
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ComponentMAXIO_UPDATE_COMPONENTAcciónUpdates a component's details in Chargify. Use when you need to modify the name, description, pricing scheme, or other attributes of an existing billing component. Only the fields you provide in the request will be updated — fields not included retain their current values. The component_id is required to identify which component to update. This action is idempotent — calling it with the same parameters will produce the same result without side effects.
MAXIO_UPDATE_COMPONENTAcciónUpdates a component's details in Chargify. Use when you need to modify the name, description, pricing scheme, or other attributes of an existing billing component. Only the fields you provide in the request will be updated — fields not included retain their current values. The component_id is required to identify which component to update. This action is idempotent — calling it with the same parameters will produce the same result without side effects.
Parámetros de entrada
namestringObligatorioThe new name of the component
handlestringA unique identifier (handle) for the component
pricesobject[]Array of price tiers to set for the component
archivedbooleanWhether the component is archived
tax_codestringA tax code identifying what tax rules apply to this component
unit_namestringThe name of the unit (e.g., 'requests', 'GB', 'users')
descriptionstringThe new description of the component
component_idintegerObligatorioThe Chargify id of the component to update
pricing_schemestringenumPricing scheme for the component.
per_unittieredvolumestair_stepupgrade_chargestringThe type of charge to apply when upgrading mid-period: 'prorated' or 'immediate'
downgrade_creditstringThe type of credit to apply when downgrading mid-period: 'prorated' or 'none'
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Component Price PointMAXIO_UPDATE_COMPONENT_PRICE_POINTAcciónUpdates 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.
MAXIO_UPDATE_COMPONENT_PRICE_POINTAcciónUpdates 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.
Parámetros de entrada
price_pointobjectNested price_point object sent in the update request body.
component_idintegerObligatorioThe Chargify id of the component to which the price point belongs.
price_point_idintegerObligatorioThe Chargify id of the price point to update.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CouponMAXIO_UPDATE_COUPONAcciónUpdates an existing coupon within a product family in Maxio. Use when you need to modify coupon details such as name, description, code, discount settings, expiration date, or redemption limits. This action supports updating any writable coupon field. All fields are optional; only provided fields will be updated on the existing coupon.
MAXIO_UPDATE_COUPONAcciónUpdates an existing coupon within a product family in Maxio. Use when you need to modify coupon details such as name, description, code, discount settings, expiration date, or redemption limits. This action supports updating any writable coupon field. All fields are optional; only provided fields will be updated on the existing coupon.
Parámetros de entrada
codestringThe coupon code. Must be unique within the product family.
namestringThe name of the coupon
durationstringenumDuration of the coupon validity.
foreversingle_userepeatingcoupon_idintegerObligatorioThe Chargify id of the coupon to update
stackablebooleanWhether the coupon can be stacked with other coupons
code_lengthintegerLength of the auto-generated coupon code (if code is not provided)
descriptionstringDescription of the coupon
discount_typestringenumType of discount for the coupon.
percentagefixedapply_on_each_renewaldiscount_amountstringFixed discount amount (when discount_type is 'fixed')
expiration_datestringExpiration date of the coupon in YYYY-MM-DD format
max_redemptionsintegerMaximum number of redemptions allowed
duration_intervalintegerNumber of billing intervals for repeating coupons (1-12)
product_family_idintegerObligatorioThe Chargify id of the product family to which the coupon belongs
discount_percentagestringPercentage discount (when discount_type is 'percentage')
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Coupon SubcodesMAXIO_UPDATE_COUPON_SUBCODESAcciónUpdates 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.
MAXIO_UPDATE_COUPON_SUBCODESAcciónUpdates 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.
Parámetros de entrada
codesstring[]ObligatorioArray 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.
coupon_idintegerObligatorioThe Chargify ID of the coupon to update subcodes for
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CustomerMAXIO_UPDATE_CUSTOMERAcciónUpdates 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.
MAXIO_UPDATE_CUSTOMERAcciónUpdates 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.
Parámetros de entrada
customerobjectNested customer object sent in the update request body. All fields are optional.
customer_idintegerObligatorioThe Chargify id of the customer to update
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Invoice Customer InformationMAXIO_UPDATE_CUSTOMER_INFORMATIONAcciónUpdates 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.
MAXIO_UPDATE_CUSTOMER_INFORMATIONAcciónUpdates 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.
Parámetros de entrada
customerobjectObligatorioThe customer object containing the fields to update. At least one field must be provided.
invoice_uidstringObligatorioThe unique identifier of the invoice (e.g., inv_c4rkt53zt457x)
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Webhook EndpointMAXIO_UPDATE_ENDPOINTAcciónUpdates 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.
MAXIO_UPDATE_ENDPOINTAcciónUpdates 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.
Parámetros de entrada
endpointobjectNested endpoint object sent in the update request body.
endpoint_idintegerObligatorioThe Chargify id of the endpoint that should be updated
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Payment ProfileMAXIO_UPDATE_PAYMENT_PROFILEAcciónUpdates 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.
MAXIO_UPDATE_PAYMENT_PROFILEAcciónUpdates 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.
Parámetros de entrada
cvvstringCard Verification Value (CVV/CVC) - the 3 or 4 digit security code on the back of the card.
companystringCompany name associated with the payment profile.
last_namestringLast name of the cardholder as it appears on the credit card.
first_namestringFirst name of the cardholder as it appears on the credit card.
billing_zipstringZIP or postal code for the billing address.
card_numberstringCredit card number (full 16-digit card number). The card number will be tokenized by the payment gateway.
vault_tokenstringToken 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.
billing_citystringCity for the billing address.
billing_statestringState or province for the billing address.
current_vaultstringThe vault where the card data is already stored. Examples: 'stripe', 'braintree', 'authorizenet'.
payment_tokenstringA tokenized payment method token from a payment gateway.
billing_addressstringStreet address for the billing address.
billing_countrystringCountry code (2-letter ISO code) for the billing address.
expiration_yearintegerExpiration year of the credit card (4-digit year).
expiration_monthintegerExpiration month of the credit card (1-12).
payment_profile_idintegerObligatorioThe Chargify id of the payment profile to update
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Prepaid ExpirationMAXIO_UPDATE_PREPAID_EXPIRATIONAcciónUpdates 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.
MAXIO_UPDATE_PREPAID_EXPIRATIONAcciónUpdates 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.
Parámetros de entrada
expires_atstringObligatorioThe new expiration date for the prepaid allocation. Format: YYYY-MM-DD.
component_idintegerObligatorioThe Chargify id of the component. This is the numeric ID of the component.
allocation_idintegerObligatorioThe Chargify id of the allocation. This is the numeric ID of the allocation to update.
subscription_idintegerObligatorioThe Chargify id of the subscription. This is the numeric ID of the subscription.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ProductMAXIO_UPDATE_PRODUCTAcciónUpdates 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.
MAXIO_UPDATE_PRODUCTAcciónUpdates 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.
Parámetros de entrada
productobjectNested product object sent in the update request body. All fields are optional.
product_idintegerObligatorioThe Chargify id of the product to update
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Product Family ComponentMAXIO_UPDATE_PRODUCT_FAMILY_COMPONENTAcciónUpdates 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.
MAXIO_UPDATE_PRODUCT_FAMILY_COMPONENTAcciónUpdates 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.
Parámetros de entrada
componentobjectComponent 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.
component_idstringObligatorioEither the Chargify id of the component or the handle for the component prefixed with `handle:`.
product_family_idintegerObligatorioThe Chargify id of the product family to which the component belongs.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Product Price PointMAXIO_UPDATE_PRODUCT_PRICE_POINTAcciónUpdates 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.
MAXIO_UPDATE_PRODUCT_PRICE_POINTAcciónUpdates 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.
Parámetros de entrada
product_idstringObligatorioThe ID or handle of the product. When using handle, prefix with 'handle:'.
price_pointobjectObligatorioThe price point object containing the fields to update. At least one field must be provided.
price_point_idstringObligatorioThe ID or handle of the price point to update. When using handle, prefix with 'handle:'.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Reason CodeMAXIO_UPDATE_REASON_CODEAcciónUpdates 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.
MAXIO_UPDATE_REASON_CODEAcciónUpdates 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.
Parámetros de entrada
reason_codeobjectNested reason code object sent in the update request body. All fields are optional.
reason_code_idintegerObligatorioThe Chargify id of the reason code to update
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update SubscriptionMAXIO_UPDATE_SUBSCRIPTIONAcciónUpdates 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.
MAXIO_UPDATE_SUBSCRIPTIONAcciónUpdates 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.
Parámetros de entrada
subscriptionobjectSubscription update fields that can be modified. All fields are optional.
subscription_idintegerObligatorioThe Chargify ID of the subscription to update
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Bulk Update Subscription Component Price PointsMAXIO_UPDATE_SUBSCRIPTION_COMPONENTS_PRICE_POINTSAcciónBulk updates component price points for a subscription. Use when you need to update multiple component price points for a subscription. Each component is updated via a separate API call sequentially, so the operation is NOT atomic - individual updates may succeed or fail independently. If a failure occurs partway through, earlier updates will NOT be rolled back. This action is idempotent - running it multiple times with the same parameters will produce the same result.
MAXIO_UPDATE_SUBSCRIPTION_COMPONENTS_PRICE_POINTSAcciónBulk updates component price points for a subscription. Use when you need to update multiple component price points for a subscription. Each component is updated via a separate API call sequentially, so the operation is NOT atomic - individual updates may succeed or fail independently. If a failure occurs partway through, earlier updates will NOT be rolled back. This action is idempotent - running it multiple times with the same parameters will produce the same result.
Parámetros de entrada
price_pointsobject[]ObligatorioArray 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.
subscription_idstringObligatorioThe unique identifier of the subscription. Can be the Chargify subscription ID or its alias.
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Subscription NoteMAXIO_UPDATE_SUBSCRIPTION_NOTEAcciónUpdates 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.
MAXIO_UPDATE_SUBSCRIPTION_NOTEAcciónUpdates 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.
Parámetros de entrada
bodystringThe updated content/body of the note
stickybooleanWhether the note should be marked as sticky. Sticky notes are displayed prominently.
note_idintegerObligatorioThe Chargify note ID to update
subscription_idintegerObligatorioThe Chargify subscription ID the note belongs to
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Validate CouponMAXIO_VALIDATE_COUPONAcciónValidates a coupon code for a product. Use when you need to verify that a coupon code exists, is active, not expired, and hasn't exceeded its redemption limit before applying it to a subscription. This is a read-only operation that does not redeem the coupon.
MAXIO_VALIDATE_COUPONAcciónValidates a coupon code for a product. Use when you need to verify that a coupon code exists, is active, not expired, and hasn't exceeded its redemption limit before applying it to a subscription. This is a read-only operation that does not redeem the coupon.
Parámetros de entrada
codestringObligatorioThe coupon code to validate
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Void Advance InvoiceMAXIO_VOID_ADVANCE_INVOICEAcciónVoids 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.
MAXIO_VOID_ADVANCE_INVOICEAcciónVoids 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.
Parámetros de entrada
reasonstringObligatorioThe reason for voiding the advance invoice
invoice_uidstringObligatorioThe unique identifier of the advance invoice to void
subscription_idintegerObligatorioThe ID of the subscription whose advance invoice should be voided
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Void InvoiceMAXIO_VOID_INVOICEAcciónVoids 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.
MAXIO_VOID_INVOICEAcciónVoids 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.
Parámetros de entrada
reasonstringThe reason for voiding the invoice. Providing a reason helps with audit trails.
invoice_uidstringObligatorioThe unique identifier of the invoice to void
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not