Maxio

Lists all price points for a component in Maxio Advanced Billing. Use this action when you need to retrieve all available pricing configurations (such as per-unit, tiered, volume, or stair-step pricing) defined for a component. This is helpful for exploring available price points before creating subscriptions, or for auditing pricing configurations across components.

Returns a list of all components across product families in Chargify. Use this action when you need to retrieve all billing components (metered, quantity-based, on/off, prepaid usage, or event-based) from your Chargify site. Supports pagination and filtering by date, IDs, handles, and archival state. This is a read-only operation that does not modify any data.

Lists all components within a product family in Maxio/Chargify. Use when you need to retrieve all billing components (metered, quantity-based, on/off, prepaid usage, or event-based) associated with a specific product family. Supports pagination with optional page and per_page parameters to handle large numbers of components efficiently.

Lists segments of a consolidated invoice. A consolidated invoice combines charges from multiple subscriptions or components into a single invoice. Use when you need to retrieve the individual segments that make up a 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.

Lists all subcodes for an existing coupon in Maxio Advanced Billing. Use when you need to retrieve the subcodes associated with a coupon for verification, reporting, or administrative purposes. This is a read-only operation that does not modify any data.

Lists all coupons within a product family. Use when you need to retrieve all available coupons for a specific product family, such as for displaying coupon options to customers or auditing coupon usage within a product family.

Returns a list of credit notes from Maxio/Chargify. Use this action when you need to retrieve credit notes for a subscription or across your entire site. Credit notes represent credits issued to customers that can be 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.

Lists all subscriptions for a specific customer in Maxio Advanced Billing. Use this action when you need to retrieve all subscriptions associated with a customer, such as for displaying subscription history, auditing 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.

Returns a list of customers with optional filtering and pagination. Use this action when you need to retrieve customers from your Chargify/Maxio billing system. Supports pagination and filtering by date range, IDs, state, organization, reference, and zip code. This is a read-only operation that does not modify any data.

Returns a list of events for the site in Maxio Advanced Billing. Use this action when you need to retrieve events for audit purposes, monitoring activity, tracking subscription changes, or analyzing payment events. 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.

Retrieves a list of exported invoices for a specific invoice export batch. Use this action when you need to fetch the rows (invoice data) from a previously initiated invoice export. The batch_id should be obtained from 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.

Lists exported proforma invoice rows from a previously initiated export batch. Use when you need to retrieve the actual data from a proforma invoices export, such as for analysis, reporting, or importing into another system. Note: The batch_id parameter should be the ID returned when the export was initiated using the Export Proforma Invoices action.

Lists exported subscriptions from a subscription export batch in Maxio/Chargify. Use this action when you need to retrieve the results of a previously initiated subscription export. The batch_id should be obtained from 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.

Lists all invoice events from Maxio/Chargify with optional filtering. Use this action when you need to retrieve invoice event history, such as tracking invoice status changes (created, paid, voided), monitoring payment 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.

Returns a list of invoices with optional filtering and pagination. Use this action when you need to retrieve invoices from Maxio/Chargify, such as for displaying invoice history, generating reports, or processing refunds. Supports filtering by status, date range, customer, subscription, and product. This is a read-only operation that does not modify any data.

Lists all metadata definitions for a resource type in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all custom metadata field definitions available for a specific resource type (customers, 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.

Lists all metafield definitions for a resource type in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all custom field (metafield) definitions configured for a specific resource type such as 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.

Returns MRR movement history showing changes in Monthly Recurring Revenue. Use this action when you need to retrieve the history of MRR changes for your Chargify site, such as for financial reporting, churn analysis, revenue tracking, or understanding subscription lifecycle metrics. This action supports date range filtering, pagination, sorting, and filtering by subscription, customer, or movement type.

Returns MRR broken down by subscription. Use this action when you need to retrieve MRR (Monthly Recurring Revenue) data for your Chargify site, including plan and usage breakouts split per subscription. This is useful 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.

Returns a list of all offers in Chargify. Use this action when you need to retrieve all offers from your Chargify site for reporting, analysis, or administrative purposes. Supports pagination and filtering by date, IDs, handles, product ID, subscription ID, offer type, and archival state. This is a read-only operation that does not modify any data.

Returns a list of payment profiles in Maxio Advanced Billing. Use this action when you need to retrieve all payment profiles (credit cards, bank accounts, or other payment methods) for verification, reporting, or 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.

Lists all prepayments for a subscription in Maxio Advanced Billing. Use this action when you need to retrieve all prepayments associated with a subscription, including their amounts, payment methods, remaining 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.

Returns a list of all product families in Maxio/Chargify. Use this action when you need to retrieve product families from your Chargify/Maxio billing system. Product families are top-level containers used to organize 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.

Lists all price points for a product in Maxio Advanced Billing. Use this action when you need to retrieve all available pricing configurations (such as monthly, annual, or trial pricing) defined for a product. This is 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.

Returns a list of all products from Maxio (Chargify). Use this action when you need to retrieve all subscription products from your Chargify site. Supports pagination and filtering by date, IDs, handles, state, and product family. This is a read-only operation that does not modify any data.

Lists all products within a product family in Maxio/Chargify. Use when you need to retrieve all subscription products associated with a specific product family, such as for displaying available plans to customers or auditing product offerings. Supports pagination with optional page and per_page parameters to handle large numbers of products efficiently.

Lists all proforma invoices for a specific subscription in Maxio Advanced Billing. Use this action when you need to retrieve the proforma invoice history for a subscription, such as for reviewing billing previews, 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.

Returns a list of all churn reason codes in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all reason codes for churn reporting and analytics, such as auditing existing codes, displaying 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.

Lists all service credits for a subscription in Maxio Advanced Billing. Use this action when you need to retrieve all service credits associated with a subscription, including their amounts, memos, and creation 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.

Lists all components attached to a subscription in Maxio (Chargify). Use this action when you need to retrieve all billing components (metered, quantity-based, on/off, prepaid usage, or event-based) associated with a 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.

Lists all subscription components for a site. Use this action when you need to retrieve all subscription components across all subscriptions in your Chargify/Maxio site. Supports pagination, sorting, and filtering by 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.

Returns a list of events for a specific subscription in Maxio Advanced Billing. Use this action when you need to retrieve all events related to a subscription, such as for audit purposes, tracking subscription changes 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.

Returns a list of subscription groups with optional filtering and pagination. Use this action when you need to retrieve subscription groups from your Chargify/Maxio billing system. Supports pagination and filtering by date range, IDs, state, customer ID, and subscription ID. This is a read-only operation that does not modify any data.

Lists all notes attached to a subscription in Maxio/Chargify Advanced Billing. Use this action when you need to retrieve all notes for a specific subscription, such as viewing customer communication history, auditing support interactions, or retrieving billing-related information stored on a subscription. This is a read-only operation that does not modify any data.

Returns a list of subscriptions with optional filtering and pagination. Use this action when you need to retrieve all subscriptions from your Chargify/Maxio billing system. Supports pagination and filtering by date 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.

Lists all usage records for a component on a subscription. Use this action when you need to retrieve the usage history for a metered or prepaid component attached to a subscription. This is useful for auditing usage, 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.

Returns a list of webhook endpoints configured in Maxio Advanced Billing. Use when you need to retrieve all registered webhook endpoints to check their current configuration, monitor which endpoints are active, or verify endpoint IDs. Supports pagination with optional page and per_page parameters to handle large numbers of endpoints efficiently.

Returns a list of webhooks configured in Maxio Advanced Billing. Use this action when you need to retrieve all webhooks to check their current configuration, monitor which webhooks are active, or verify webhook IDs. Supports pagination and optional filtering by active status. This is a read-only operation that does not modify any data.

Previews allocation charges before creating them for subscription components. Use this action when you need to calculate the cost impact of adding, upgrading, downgrading, or removing components from a subscription 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.

Previews customer information changes for an invoice. This endpoint shows what the invoice would look like with updated customer information before the changes are actually applied. Use when you need to preview how 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.

Previews a proforma invoice for a subscription without actually creating it. Use when you need to preview the expected charges and invoice details before committing to create the actual proforma invoice. This is useful 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.

Previews the next renewal charges for a subscription in Maxio (Chargify). Use this action when you need to show customers what their next billing amount will be at renewal, including any component charges, discounts, 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.

Previews a subscription in Maxio (Chargify) before actual creation to see pricing and details. Use this action when you want to validate subscription parameters, preview costs, or show users what a subscription will 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.

Previews a product migration before executing it. Use this action when you need to see what will happen when migrating a subscription to a different product without actually making the change. This allows you to review 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.

Retrieves the account balances for a subscription in Maxio Advanced Billing. Use this action when you need to check the current financial status of a subscription, including any outstanding invoice amounts, service 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.

Retrieves an advance invoice for a subscription. An advance invoice shows the charges that will be billed in advance of the normal billing cycle. Use this action when you need to preview or retrieve the advance billing 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.

Retrieves details of a specific component within a product family in Maxio/Chargify. Use this action when you need to fetch detailed information about a single billing component (metered, quantity-based, on/off, prepaid usage, or event-based) including its pricing, configuration, and metadata. This is a read-only operation that does not modify any data.

Finds a component by its unique handle in Maxio/Chargify. Use this action when you need to retrieve a specific billing component using its handle identifier. The handle is a unique string that identifies the component 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.

Retrieves a specific component price point in Maxio Advanced Billing. Use this action when you need to fetch the details of a single price point, including its pricing scheme, price tiers, and configuration settings. 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.

Retrieves details of a specific coupon within a product family. Use this action when you need to fetch the full details of a coupon, such as its discount configuration, redemption status, or to verify coupon properties before applying it to a subscription.

Retrieves usage statistics for a coupon. Use when you need to view how many times a coupon has been redeemed, the total discount given, and other usage metrics for a specific coupon within a product family. This is a read-only action that retrieves current statistics from the API.

Retrieves details of a specific credit note from Maxio/Chargify. Use this action when you need to retrieve detailed information about a specific credit note by its unique identifier (UID). This is a read-only operation 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

Retrieves details of a specific customer by their Chargify ID. Use this action when you need to fetch the full details of a customer, such as their contact information, address, tax status, or billing portal status. This is a read-only operation that does not modify any data.

Looks up a customer by their external reference value. Use this action when you have an external reference identifier for a customer and need to retrieve the full customer details from Maxio/Chargify. Returns the 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.

Returns a count of events for the site in Maxio Advanced Billing. Use this action when you need to quickly determine the number of events matching specific criteria without retrieving full event details. This is useful for checking event volume, validating data existence, or preparing for paginated queries. Supports filtering by date range (since/until), event type, and custom filters.

Retrieves details of a specific invoice by its unique identifier (UID). Use this action when you need to fetch complete information about a single invoice, such as for displaying invoice details, processing refunds, or 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.

Retrieves the status and details of an invoices export batch job. Use when you need to check whether a previously initiated invoice export has completed and how many rows were exported. This endpoint returns the batch 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.

Retrieves details of a specific offer by its ID from Maxio (Chargify). Use this action when you need to fetch full details of a single offer, including product information, discounts, items, and signup pages. This is a read-only operation that does not modify any data.

Retrieves details of a specific payment profile in Maxio Advanced Billing. Use this action when you need to fetch details of a payment profile by its ID, such as verifying card information, retrieving vault tokens for 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.

Retrieves details of a specific product by its ID from Maxio (Chargify). Use this action when you need to fetch full details of a single product, including pricing, billing intervals, trial settings, and product family information. This is a read-only operation that does not modify any data.

Retrieves a single product from Maxio (Chargify) by its unique handle. Use this action when you need to fetch a specific product's details using its handle identifier rather than its numeric ID. This is useful for 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.

Retrieves details of a specific product family in Maxio/Chargify. Use this action when you need to fetch the full details of a product family, such as its name, description, handle, accounting code, or associated signup pages. This is a read-only operation that does not modify any data.

Retrieves a specific product price point in Maxio Advanced Billing. Use this action when you need to fetch the details of a single price point, including its pricing configuration, interval settings, and trial options. 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.

Retrieves a specific proforma invoice by its unique identifier. Use this action when you need to fetch detailed information about a single proforma invoice, including line items, amounts, taxes, discounts, customer and 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.

Retrieves the status and details of a proforma invoices export batch job. Use when you need to check the status of a previously initiated proforma invoices export, such as to verify completion before fetching the 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.

Retrieves a specific churn reason code by its ID from Maxio/Chargify Advanced Billing. Use this action when you need to fetch details of a single reason code, such as when viewing specific churn categorization 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.

Retrieves details about the current Chargify/Maxio site. Use this action when you need to retrieve information about your Chargify site, including site configuration, address, tax settings, and gateway information. 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.

Returns site-wide statistics for the Chargify site. Use this action when you need to retrieve aggregate statistics about your Chargify site, including subscription counts by status, Monthly Recurring Revenue (MRR) 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.

Retrieves details of a specific subscription by its unique identifier (ID). Use this action when you need to fetch complete information about a single subscription, such as for displaying subscription details, checking 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.

Finds a subscription by its external reference identifier in Maxio Advanced Billing. Use this action when you need to retrieve a specific subscription using its reference field rather than the internal Chargify 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.

Retrieves details of a component attached to a subscription in Maxio (Chargify). Use this action when you need to fetch detailed information about a specific billing component (metered, quantity-based, on/off, prepaid 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.

Retrieves a specific note attached to a subscription in Maxio/Chargify Advanced Billing. Use this action when you need to fetch a single note from a subscription, such as retrieving details about a specific customer interaction, viewing a particular support note, or accessing billing-related annotations. This is a read-only operation that does not modify any data.

Retrieves the status and details of a subscriptions export batch job. Use this action when you need to check whether a previously initiated subscription export has completed and how many rows were exported. This is 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.

Validates a coupon code for a product. Use when you need to verify that a coupon code exists, is active, not expired, and hasn't exceeded its redemption limit before applying it to a subscription. This is a read-only operation that does not redeem the coupon.

Creates a new subscription in Maxio (Chargify) with specified product, customer, and payment details. Use this action when you need to create a new subscription for an existing or new customer. At minimum, either 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).

Creates a subscription group with subscriptions and a shared payer in a single operation. Use this action when you need to create a subscription group that includes multiple subscriptions and a single payer who is 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.

Creates a note on a subscription in Maxio/Chargify Advanced Billing. Use this action when you need to add a note or comment to a subscription, such as tracking customer communication, recording support interactions, or documenting billing-related information.

Deducts from a subscription's service credit balance. Use this action when you need to reduce or correct a customer's service credit balance, such as for refunds, billing corrections, or adjusting for erroneous credits. Note: The amount will be deducted from the subscription's available service credit balance. Ensure the subscription has sufficient credit before deducting.

Issues an advance invoice for a subscription. An advance invoice allows billing for upcoming charges in advance of the normal billing cycle. Use this action when you need to immediately bill a customer for expected 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.

Issues a service credit to a subscription. Service credits are amounts that are added to a subscription's service credit balance and can be applied toward future invoices. Use this action when you need to compensate a 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.

Tool to record multiple billable events in bulk for a subscription component. Use when you need to log several usage events at once, such as batch processing usage data or recording multiple overage events. Each event can specify its own quantity and memo. Maximum 1000 events per request.

Clones an existing component price point to create a new one. Use this action when you need to duplicate a price point with all its pricing configuration, optionally providing a new name for the cloned version. The cloned price point will inherit all pricing settings from the source price point including the pricing scheme, prices, and currency configuration.

Creates a new component within a product family in Chargify. Use when you need to add billing components like metered usage, quantity-based pricing, on/off toggles, prepaid usage, or event-based components to a product 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).

Creates multiple subcodes for an existing coupon in Maxio Advanced Billing. Use when you need to add additional coupon codes for tracking, segmentation, or allowing multiple uses of a coupon. Subcodes are tied to the 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.

Creates a one-time invoice for a subscription with custom line items. Use when you need to bill a customer for a one-time charge or custom amount that is not part of their regular subscription. The invoice can include multiple line items with titles, descriptions, quantities, and prices.

Creates metafield definitions for a resource type. Use this action when you need to define custom fields that can be attached to resources like customers, subscriptions, or products. After creating a metafield 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.

Creates a new payment profile for a customer in Maxio (Chargify). Use when you need to add a new credit card or payment method to a customer's account. The payment profile stores card details securely and returns a vault token for future use.

Creates a prepaid usage component for pre-purchased units. Use when you need to create a component that allows customers to prepay for usage-based charges such as SMS credits, API calls, or storage units. The component 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.

Creates a quantity-based component for recurring units within a product family. Use when you need to add billing components that charge per unit based on quantity, such as user licenses, team seats, or device slots. 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.

Records usage for a metered component on a subscription. Use this action when you need to track and bill for usage-based consumption such as API calls, storage GB, emails sent, or any other metered usage. This action 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

Creates a new webhook endpoint in Maxio Advanced Billing. Use when you need to register a new webhook endpoint to receive event notifications.

Delivers a proforma invoice to the customer via email. Use when you need to email a proforma invoice to the customer. By default, the invoice will be sent to the customer on the subscription. Optionally, you can 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.

Sends an invoice to the customer via email. Use when you need to email an invoice to the customer. By default, the invoice will be sent to the customer on the subscription. Optionally, you can specify custom recipient email addresses to override the defaults. This action sends the invoice immediately and triggers the delivery process to all specified recipients.

Applies one or more coupons to a subscription. Use when you need to apply promotional discounts or coupon codes to an existing subscription. The coupon must be valid and not expired for the operation to succeed.

Bulk updates component price points for a subscription. Use when you need to update multiple component price points for a subscription. Each component is updated via a separate API call sequentially, so the operation 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.

Tool to create or update currency prices for a coupon in Maxio. Use when you need to set or modify the pricing of a coupon across different currencies. This action is idempotent - calling it will replace all existing currency prices for the coupon with the new values provided.

Deactivates an event-based component on a subscription. Use when you need to disable event-based billing on a subscription, such as pausing usage tracking or stopping billing for a specific component. This action is 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.

Enables or disables webhooks for the Maxio/Chargify site. Use this action when you need to turn webhook notifications on or off. This can be useful during maintenance windows, troubleshooting, or when temporarily 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.

Schedules a subscription for cancellation at the end of its current billing period. Use when a customer requests to cancel their subscription but you want to allow them to continue using the service until the end of 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.

Migrates a subscription to a different product in Maxio/Chargify Advanced Billing. Use when you need to change a subscription's product (e.g., upgrade, downgrade, or change the subscription plan). This action will 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.

Overrides cancellation settings of a subscription. Use when you need to update cancellation-related attributes on an existing subscription, such as adding a cancellation message to explain why the subscription was overridden. This action sends an override request to update the subscription's cancellation settings. The API returns HTTP 204 No Content on success.

Pauses an active subscription in Maxio (Chargify) Advanced Billing. Use when you need to temporarily suspend a subscription without canceling it, such as when a customer requests a pause in service or when there are 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').

Promotes a component price point to be the default price point for its component. Use this action when you need to change which price point is used as the default for new subscriptions. This endpoint switches the 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.

Promotes a product price point to be the default price point for a product. Use when you need to change which price point is automatically selected for new subscriptions to a product. This action sets the specified 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.

Reactivates a canceled subscription in Maxio (Chargify) Advanced Billing. Use when you need to restore a previously canceled subscription and resume billing for the customer. This action is reversible — you can cancel 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.

Reactivates a canceled subscription group in Maxio/Chargify. Use this action when you need to restore a previously canceled subscription group and resume billing for all its associated subscriptions. This action is reversible — you can cancel the group again if needed.

Records a payment for an invoice. This action can be used to record both full and partial payments against an invoice. Use this action when you need to record a customer payment for an existing invoice. The payment 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.

Reopens a voided or canceled invoice, changing its status back to open. Use when you need to reinstate an invoice that was previously voided or canceled. This action allows the invoice to be paid or modified again. 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.

Replays specified webhook deliveries in Maxio Advanced Billing. Use this action when you need to resend webhooks that may have failed, were not delivered, or need to be resent for any reason. Provide a list of webhook IDs to replay their corresponding events. This action is idempotent — calling it with the same webhook IDs will resend the same webhooks again.

Resumes a paused subscription in Maxio (Chargify) Advanced Billing. Use when you need to restore a previously paused subscription and resume billing and service delivery. This action is reversible — you can pause the 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.

Retries payment for a past due subscription in Maxio (Chargify) Advanced Billing. Use when a subscription has failed payments and you need to manually trigger a retry of the billing attempt. This is useful when the 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.

Sends an email to the customer requesting they update their payment method. Use when you need to prompt a customer to update their credit card or payment method on file. This is typically used when their current 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.

Unarchives a component price point, restoring it to active status. Use this action when you need to reactivate an archived price point that was previously deactivated. Once unarchived, the price point becomes available for new subscriptions again. This action is idempotent — unarchiving an already active price point has no effect.

Unarchives a previously archived offer, making it available for new subscriptions again. Use this action when you need to restore an archived offer that was previously deactivated. This action is idempotent — unarchiving an already active offer has no effect.

Unarchives a product price point by its ID. Use when you need to restore an archived price point that was previously deactivated. Once unarchived, the price point becomes available for new subscriptions again. This action is idempotent — unarchiving an already active price point has no effect.

Updates automatic resumption settings for a paused subscription in Maxio (Chargify) Advanced Billing. Use when you need to enable or disable automatic resumption for a subscription that is in a paused (hold) state. 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.

Updates a component's details in Chargify. Use when you need to modify the name, description, pricing scheme, or other attributes of an existing billing component. Only the fields you provide in the request will be 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.

Updates an existing coupon within a product family in Maxio. Use when you need to modify coupon details such as name, description, code, discount settings, expiration date, or redemption limits. This action supports updating any writable coupon field. All fields are optional; only provided fields will be updated on the existing coupon.

Updates all subcodes for an existing coupon in Maxio Advanced Billing. Use when you need to replace the entire set of subcodes for a coupon with a new set of codes for tracking, segmentation, or managing coupon usage. 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.

Updates customer information on an invoice in Maxio/Chargify. Use this action when you need to modify customer details (such as name, email, organization) associated with a specific invoice. Only the fields provided in 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.

Updates an existing payment profile in Maxio (Chargify). Use when you need to modify an existing payment profile's details such as card information, billing address, or contact details. At least one field must be 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.

Updates the expiration date of a prepaid usage allocation. Use this action when you need to extend or change the expiration date of a prepaid allocation on a subscription component. This action is commonly used to: - 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.

Updates a component within its product family in Maxio/Chargify. Use this action when you need to modify the configuration of an existing billing component (metered, quantity-based, on/off, prepaid usage, or 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.

Updates an existing webhook endpoint in Maxio Advanced Billing. Use when you need to modify an endpoint's URL or description. This action is idempotent - updating an endpoint with the same values will not change the endpoint. Only the fields provided in the endpoint object will be updated. Fields not included in the request will retain their current values.

Deletes a customer from Maxio/Chargify. Use this action when you need to permanently remove a customer record. This action is irreversible — once deleted, the customer cannot be recovered. Note: A customer can only be deleted if they have no associated subscriptions. Attempting to delete a customer with active subscriptions will result in an error.

Deletes a prepaid usage allocation from a subscription component. Use this action when you need to remove a specific prepaid allocation that was previously created. This action is irreversible — once deleted, the 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.

Deletes a churn reason code from Maxio/Chargify Advanced Billing. Use this action when you need to permanently remove a reason code from your account. This action is irreversible — once deleted, the reason code cannot be recovered, and any associated reporting data will be affected. Note: This endpoint returns a 404 error if the reason code does not exist.

Deletes a subscription group and all its associated data. Use this action when you need to permanently remove a subscription group from the system. This action is irreversible — once deleted, the subscription group and all its subscriptions cannot be recovered.

Deletes a specific note from a subscription in Maxio Advanced Billing. Use this action when you need to remove a single note from a subscription. This action is irreversible — the note will be permanently deleted and cannot be recovered once removed.

Removes a payment profile from a subscription in Maxio Advanced Billing. Use when you need to unlink a credit card or payment method from a subscription, for example, when cleaning up obsolete payment profiles or 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.

Permanently deletes an unused payment profile from Maxio/Chargify. Use when you need to remove a payment profile that is no longer associated with any active subscriptions or payment references. This action is 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).

Issues a draft invoice for payment collection. Once issued, the invoice transitions from 'draft' to 'open' state and is ready to collect payment. Use when you need to finalize a draft invoice and initiate the payment 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.

Creates a refund for a paid invoice. Use this action when you need to process a refund for a customer whose invoice has already been paid. The refund will be recorded against the invoice and a credit note may be 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.

Removes an applied coupon from a subscription in Maxio (Chargify) Advanced Billing. Use when you need to remove a promotional discount from an existing subscription and restore regular pricing. This action is 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.

Removes a subscription from its subscription group in Maxio Advanced Billing. Use this action when you need to unlink a subscription from its group, such as when migrating a subscription to operate independently or reorganizing group membership. This action is irreversible — once the subscription is removed from the group, it cannot be recovered through this endpoint.

Revokes billing portal access for a customer. This action invalidates the customer's current billing portal invitation, preventing them from accessing the self-service portal to view invoices, update payment methods, 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.

Voids an open invoice to stop future collection. Once voided, the invoice transitions from 'open' (or 'draft') to 'voided' state and will not be collected. Use when you need to cancel an invoice before payment is 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.