# Maxio Advanced Billing integration

> Subscription billing API (formerly Chargify): customers, subscriptions, products, components, coupons, invoices, payment profiles, and usage.

- Authentication: apiKey

## Tools (294)

- **Activate Event Based Component**: Activates an event-based component for a single subscription.
- **Activate Subscription**: Activates awaiting signup and trialing subscriptions.
- **Add Subscription to Group**: Adds an existing subscription to a subscription group.
- **Allocate Component**: Creates an allocation, sets the current allocated quantity for the component, and records a memo.
- **Allocate Components**: Creates multiple allocations, sets the current allocated quantity for each of the components, and records a memo.
- **Apply Coupons to Subscription**: Applies one or more coupon codes to an existing subscription.
- **Archive Component**: Archives the component; all current subscribers will continue to be charged as usual.
- **Archive Component Price Point**: Archives a component price point.
- **Archive Coupon**: Archives a coupon, making it unavailable for future use while remaining active on existing subscriptions.
- **Archive Feature Template**: Archives a feature template.
- **Archive Offer**: Archives an existing offer.
- **Archive Product**: Archives the product.
- **Archive Product Price Point**: Archives a product price point.
- **Archive Wallet**: Archives the wallet: blocks further grants, debits, adjustments, and purchases (each returns `422`), stops any metered drawdown, and stops recurring funding (its schedule is deactivated with reason `wallet_archived`, not removed), while reads and the ledger stay available.
- **Archive Wallet Product**: Archives the Wallet Product.
- **Bulk Create Component Price Points**: Creates multiple component price points in one request.
- **Bulk Create Product Price Points**: Creates multiple product price points in one request.
- **Bulk Create Segments**: Creates multiple segments in one request.
- **Bulk Record Events**: Records a collection of events.
- **Bulk Reset Subscription Components Price Points**: Resets all of a subscription's components to use the current default.
- **Bulk Update Segments**: Updates multiple segments in one request.
- **Bulk Update Subscription Components Price Points**: Updates the price points on one or more of a subscription's components.
- **Cancel Delayed Cancellation**: Removes the delayed cancellation from a subscription, ensuring it is not canceled at the end of the current period.
- **Cancel Delayed Cancellation for Group**: Removes the delayed cancellation on a subscription group.
- **Cancel Dunning**: Cancels the active dunning process for a subscription and sets it to active.
- **Cancel Scheduled Renewal Configuration**: Cancels a scheduled renewal configuration.
- **Cancel Subscription**: Cancels the Subscription.
- **Cancel Subscriptions in Group**: Cancels all subscriptions within the specified group immediately.
- **Change Subscription Default Payment Profile**: Changes the default payment profile on the subscription to the existing payment profile with the specified ID.
- **Change Subscription Group Default Payment Profile**: Changes the default payment profile on the subscription group to the existing payment profile with the specified ID.
- **Clear Site**: Clears all data from a test site asynchronously.
- **Clone Component Price Point**: Clones a component price point.
- **Create Component Feature**: Attaches a feature template to this component with a concrete value.
- **Create Component Price Point**: Creates a price point for an existing component.
- **Create Consolidated Proforma Invoice**: Creates a consolidated proforma invoice asynchronously.
- **Create Coupon**: Creates a coupon under the specified product family.
- **Create Coupon Subcodes**: Creates subcodes for an existing coupon.
- **Create Currency Prices**: Creates currency prices for a given currency defined at the site level.
- **Create Customer**: Creates a new customer; can also be created alongside a new subscription.
- **Create Endpoint**: Creates an endpoint and assigns a list of webhook subscriptions (events) to it.
- **Create Event Based Component**: Creates an event-based component definition under the specified product family.
- **Create Feature Template**: Defines a new feature at the site level.
- **Create Invoice**: Creates an ad hoc invoice.
- **Create Metadata**: Creates metadata and metafields for a specific subscription or customer, or updates metadata values of existing metafields for a subscription or customer.
- **Create Metafields**: Creates metafields on a Site for either the Subscriptions or Customers resource.
- **Create Metered Component**: Creates a metered component definition under the specified product family.
- **Create Offer**: Creates an offer within your site.
- **Create On Off Component**: Creates an On/Off component definition under the specified product family.
- **Create or Update Coupon Currency Prices**: Creates and/or updates currency prices for an existing coupon.
- **Create Payment Profile**: Creates a payment profile for a customer.
- **Create Prepaid Usage Component**: Creates a prepaid usage component definition under the specified product family.
- **Create Prepayment**: Creates a prepayment for a subscription.
- **Create Product**: Creates a product in your site.
- **Create Product Currency Prices**: Creates currency prices for a given currency that has been defined on the site level in your settings.
- **Create Product Family**: Creates a Product Family within your site.
- **Create Product Feature**: Attaches a feature template to this product with a concrete value.
- **Create Product Price Point**: Creates a Product Price Point.
- **Create Proforma Invoice**: Creates a proforma invoice and returns it as a response.
- **Create Quantity Based Component**: Creates a Quantity Based component definition under the specified product family.
- **Create Reason Code**: Creates a reason code for a given site.
- **Create Scheduled Renewal Configuration**: Creates a scheduled renewal configuration for a subscription.
- **Create Scheduled Renewal Configuration Item**: Adds product and component line items to the scheduled renewal.
- **Create Segment**: Creates a new segment for a component with a segmented metric.
- **Create Signup Proforma Invoice (bank account)**: Creates a proforma invoice to preview costs before a subscription's signup.
- **Create Signup Proforma Invoice (credit card)**: Creates a proforma invoice to preview costs before a subscription's signup.
- **Create Signup Proforma Invoice (existing payment profile)**: Creates a proforma invoice to preview costs before a subscription's signup.
- **Create Signup Proforma Invoice (no payment method)**: Creates a proforma invoice to preview costs before a subscription's signup.
- **Create Subscription (bank account)**: Creates a Subscription for a customer and product.
- **Create Subscription (credit card)**: Creates a Subscription for a customer and product.
- **Create Subscription (existing payment profile)**: Creates a Subscription for a customer and product.
- **Create Subscription Group**: Creates a subscription group with given members.
- **Create Subscription Group Prepayment**: Adds a prepayment for a subscription group.
- **Create Subscription (no payment method)**: Creates a Subscription for a customer and product.
- **Create Subscription Note**: Creates a note for a subscription.
- **Create Usage**: Records an instance of metered or prepaid usage for a subscription.
- **Create Wallet**: Creates a wallet owned by a subscription and denominated by a Wallet Product: only a Wallet Product can denominate a wallet, not an ordinary component.
- **Create Wallet Adjustment**: Posts a signed correction against a specific grant (or, for an overdraft entry, against the overdraft): positive adds units to the grant, negative removes them.
- **Create Wallet Product**: Creates a Wallet Product: a billing product with no product family, meant to denominate wallets and to be purchased through Create Wallet Purchase.
- **Create Wallet Purchase**: Purchases prepaid units for the wallet and charges the subscription's payment method for them, using the wallet's `price_point_id` unless a different price point is named.
- **Create Wallet Transaction**: Grants units to the wallet, or debits units from it, depending on `kind`.
- **Deactivate Event Based Component**: Deactivates an event-based component for a single subscription.
- **Deduct Service Credit**: Deducts a service credit from the subscription in the specified amount.
- **Deduct Subscription Group Service Credit**: Deducts service credit for a subscription group.
- **Delete Coupon Subcode**: Deletes a specific subcode from a coupon.
- **Delete Customer**: Deletes the customer.
- **Delete Invoice**: Deletes an ad hoc invoice while it is in the `draft` state.
- **Delete Metadata**: Deletes one or more metafields (and associated metadata) from the specified subscription or customer.
- **Delete Metafield**: Deletes a metafield from your Site.
- **Delete Prepaid Usage Allocation**: Deletes a prepaid usage allocation.
- **Delete Reason Code**: Deletes a reason code from the Churn Reason Codes.
- **Delete Scheduled Renewal Configuration Item**: Removes an item from the pending renewal configuration.
- **Delete Segment**: Deletes a segment with the specified ID.
- **Delete Subscription Group**: Deletes a subscription group.
- **Delete Subscription Group Payment Profile**: Deletes a Payment Profile belonging to a Subscription Group.
- **Delete Subscription Note**: Deletes a note for a Subscription.
- **Delete Subscriptions Payment Profile**: Deletes a payment profile belonging to the customer on the subscription.
- **Delete Unused Payment Profile**: Deletes an unused payment profile.
- **Deliver Proforma Invoice**: Delivers a proforma invoice programmatically via email.
- **Enable Billing Portal for Customer**: Enables Billing Portal access for a customer, with an option to send an invitation email at the same time.
- **Enable Webhooks**: Enables webhooks for your site.
- **Export Invoices**: Creates an invoices export and returns a batch job object.
- **Export Proforma Invoices**: Creates a proforma invoices export and returns a batch job object.
- **Export Subscriptions**: Creates a subscriptions export and returns a batch job object.
- **Find Component**: Returns information for a component matching the provided handle.
- **Find Coupon**: Searches for a coupon by code.
- **Find Subscription**: Finds a subscription by its reference.
- **Find Subscription Group**: Finds the subscription group associated with a subscription.
- **Initiate Delayed Cancellation**: Cancels a subscription at the end of the current billing period based on the subscription's current product.
- **Initiate Delayed Cancellation for Group**: Schedules all subscriptions within the specified group to be canceled at the end of their billing period.
- **Issue Advance Invoice**: Issues an invoice in advance for a subscription's next renewal date.
- **Issue Invoice**: Issues an invoice that is in "pending" or "draft" status..
- **Issue Service Credit**: Adds a service credit to the subscription in the specified amount.
- **Issue Subscription Group Service Credit**: Issues service credit for a subscription group.
- **List All Component Price Points**: Lists all component price points belonging to a site.
- **List Allocations**: Lists the 50 most recent Allocations, ordered by most recent first.
- **List All Product Price Points**: Lists Product Price Points belonging to a site.
- **List Chargify Js Public Keys**: Lists public keys used for Maxio.js (formerly Chargify.js).
- **List Component Features**: Lists the feature catalog items attached to this component, including price-point-specific overrides.
- **List Component Price Points**: Lists the price points associated with a component.
- **List Components**: Lists components for a site.
- **List Components for Product Family**: Lists components for a particular product family.
- **List Consolidated Invoice Segments**: Lists segments for a consolidated invoice.
- **List Coupons**: Lists coupons for a site.
- **List Coupons for Product Family**: Lists coupons for a specific product family in a site.
- **List Coupon Subcodes**: Lists the subcodes attached to a coupon.
- **List Credit Notes**: Lists credit notes for a site.
- **List Customers**: Lists all customers associated with your site, or filters results using the search parameter.
- **List Customer Subscriptions**: Lists all subscriptions that belong to a customer.
- **List Endpoints**: Lists endpoints configured for a site.
- **List Events**: Lists events for a site.
- **List Exported Invoices**: Lists exported invoices for a provided `batch_id`.
- **List Exported Proforma Invoices**: Lists exported proforma invoices for a provided `batch_id`.
- **List Exported Subscriptions**: Lists exported subscriptions for a provided `batch_id`.
- **List Feature Templates**: Lists the feature templates defined for your site, active (non-archived) ones by default.
- **List Invoice Events**: Lists invoice events for a site.
- **List Invoices**: Lists invoices for a site.
- **List Metadata**: Lists metadata and metafields for a specific customer or subscription.
- **List Metadata for Resource Type**: Lists metadata for a specified array of subscriptions or customers.
- **List Metafields**: Lists the metafields and their associated details for a Site and resource type.
- **List Mrr Movements**: **This endpoint is deprecated.** Lists your site's MRR movements.
- **List Mrr per Subscription**: **This endpoint is deprecated.** Lists your site's current MRR, including plan and usage breakouts split per subscription.
- **List Offers**: Lists offers for a site.
- **List Payment Profiles**: Lists all active payment profiles for a site, or for one customer within a site.
- **List Prepayments**: Lists a subscription's prepayments.
- **List Prepayments for Subscription Group**: Lists a subscription group's prepayments.
- **List Product Families**: Lists Product Families for a site.
- **List Product Features**: Lists the feature catalog items attached to this product, including price-point-specific overrides.
- **List Product Price Points**: Retrieves a list of product price points.
- **List Products**: Lists products belonging to a site.
- **List Products for Product Family**: Retrieves a list of Products belonging to a Product Family.
- **List Proforma Invoices**: Lists proforma invoices for a subscription.
- **List Reason Codes**: Lists all current churn codes for a given site.
- **List Scheduled Renewal Configurations**: Lists scheduled renewal configurations for the subscription and permits an optional status query filter.
- **List Segments for Price Point**: Lists segments created for a given price point, in order of creation.
- **List Service Credits**: Lists a subscription's service credits.
- **List Subscription Components**: Lists a subscription's applied components.
- **List Subscription Components for Site**: Lists components applied to each subscription.
- **List Subscription Events**: Lists events for a subscription.
- **List Subscription Group Proforma Invoices**: Lists proforma invoices with a `consolidation_level` of parent for the subscription group.
- **List Subscription Groups**: Lists subscription groups for the site.
- **List Subscription Notes**: Retrieves a list of notes associated with a subscription.
- **List Subscriptions**: Lists subscriptions for a site.
- **List Usages**: Lists usages associated with a subscription for a particular metered component.
- **List Wallet Products**: Lists the Wallet Products on your site.
- **List Wallets**: Lists the wallets on your site, in creation order, paginated.
- **List Wallet Transactions**: Lists the wallet's append-only ledger, newest first, paginated.
- **List Webhooks**: Retrieves a list of webhooks.
- **Lock in Scheduled Renewal Immediately**: Locks in the renewal immediately.
- **Migrate Subscription Product**: Migrates a subscription to a different product.
- **Override Subscription**: Sets certain subscription fields that are usually managed automatically.
- **Pause Subscription**: Places the subscription on hold, preventing it from renewing.
- **Preview Allocations**: Previews a potential subscription's **quantity-based** or **on/off** component allocation in the middle of the current billing period.
- **Preview Customer Information Changes**: Previews the effect of customer information changes on an open invoice.
- **Preview Proforma Invoice**: Previews the data that will be included on a given subscription's proforma invoice if one were to be generated.
- **Preview Renewal**: Previews a subscription’s next renewal assessment.
- **Preview Signup Proforma Invoice (bank account)**: Creates a signup preview in the format of a proforma invoice to preview costs before a subscription's signup.
- **Preview Signup Proforma Invoice (credit card)**: Creates a signup preview in the format of a proforma invoice to preview costs before a subscription's signup.
- **Preview Signup Proforma Invoice (existing payment profile)**: Creates a signup preview in the format of a proforma invoice to preview costs before a subscription's signup.
- **Preview Signup Proforma Invoice (no payment method)**: Creates a signup preview in the format of a proforma invoice to preview costs before a subscription's signup.
- **Preview Subscription (bank account)**: Previews a subscription by POSTing the same JSON or XML as for a subscription creation.
- **Preview Subscription (credit card)**: Previews a subscription by POSTing the same JSON or XML as for a subscription creation.
- **Preview Subscription (existing payment profile)**: Previews a subscription by POSTing the same JSON or XML as for a subscription creation.
- **Preview Subscription (no payment method)**: Previews a subscription by POSTing the same JSON or XML as for a subscription creation.
- **Preview Subscription Product Migration**: Previews the charges resulting from migrating a subscription to a different product.
- **Preview Wallet Purchase**: Quotes the price for a purchase at the given quantity and price point, without charging the payment method or writing to the wallet.
- **Promote Component Price Point to Default**: Sets a new default price point for the component.
- **Promote Product Price Point to Default**: Sets a product price point as the default for the product.
- **Purge Subscription**: Purges an individual subscription for sites in test mode.
- **Reactivate Subscription**: Reactivates a previously canceled subscription.
- **Reactivate Subscription Group**: Reactivates or resumes a cancelled subscription group.
- **Read Account Balances**: Returns the `balance_in_cents` of the Subscription's Pending Discount, Service Credit, and Prepayment accounts, as well as the sum of the Subscription's open, payable invoices.
- **Read Advance Invoice**: Returns the advance invoice generated for a subscription's upcoming renewal.
- **Read Billing Portal Link**: Returns the exact URL required for a subscriber to access the Billing Portal.
- **Read Component**: Returns information regarding a component from a specific product family.
- **Read Component Feature**: Returns a single feature catalog item attached to this component.
- **Read Component Price Point**: Returns details for a specific component price point.
- **Read Coupon**: Returns a coupon by its system-assigned ID.
- **Read Coupon Usage**: Lists coupon usage details, one entry per product.
- **Read Credit Note**: Returns the details for a credit note.
- **Read Customer**: Retrieves the Customer properties by Advanced Billing-generated Customer ID.
- **Read Customer by Reference**: Returns a customer by their unique reference ID.
- **Read Events Count**: Returns the total count of events for a given site.
- **Read Feature Template**: Returns a single feature template.
- **Read Invoice**: Returns the details for an invoice.
- **Read Invoices Export**: Returns a batch job object for an invoices export.
- **Read Mrr**: **This endpoint is deprecated.** Returns your site's current MRR, including plan and usage breakouts.
- **Read Offer**: Returns a specific offer's attributes.
- **Read One Time Token**: Returns the one-time token data, including credit card or ACH details, associated with the provided token ID.
- **Read Payment Profile**: Returns a payment profile identified by its unique ID.
- **Read Product**: Reads the current details of a product.
- **Read Product by Handle**: Retrieves a Product object by its `api_handle`.
- **Read Product Family**: Retrieves a Product Family via the `product_family_id`.
- **Read Product Feature**: Returns a single feature catalog item attached to this product.
- **Read Product Price Point**: Returns details for a specific product price point.
- **Read Proforma Invoice**: Returns the details of an existing proforma invoice.
- **Read Proforma Invoices Export**: Returns a batch job object for a proforma invoices export.
- **Read Reason Code**: Returns a particular churn reason code for a given site by its unique ID.
- **Read Scheduled Renewal Configuration**: Retrieves the configuration settings for the scheduled renewal.
- **Read Site**: Retrieves site data.
- **Read Site Stats**: Returns basic site-level stats.
- **Read Subscription**: Retrieves subscription details.
- **Read Subscription Component**: Returns information for a specific component on a subscription.
- **Read Subscription Entitlements**: Returns every feature a subscription is entitled to, collapsed into one entry per feature key and periodicity window across all products and components on the subscription.
- **Read Subscription Group**: Returns subscription group details.
- **Read Subscription Note**: Retrieves a specific note attached to a subscription.
- **Read Subscriptions Export**: Returns a batch job object for a subscriptions export.
- **Read Wallet**: Returns the wallet's balance and grant breakdown.
- **Read Wallet Product**: Returns the Wallet Product.
- **Read Wallet Product Usage**: Returns everything drawing on this Wallet Product: the wallet templates billing through it, split into ones using its default price point and ones overriding it, plus a sample of up to 50 of the active wallets actually created from them.
- **Record Event**: Records a single event for Events-Based Billing.
- **Record Payment for Invoice**: Applies a payment of a given type against a specific invoice.
- **Record Payment for Multiple Invoices**: Records an external payment against multiple invoices.
- **Record Payment for Subscription**: Records an external payment made against a subscription that will pay partially or in full one or more invoices.
- **Refund Invoice**: Refunds an invoice, segment, or consolidated invoice.
- **Refund Prepayment**: Refunds a prepayment applied to a subscription, either fully or partially.
- **Remove Component Feature**: Removes a feature catalog item from this component.
- **Remove Coupon from Subscription**: Removes a coupon from an existing subscription.
- **Remove Product Feature**: Removes a feature catalog item from this product.
- **Remove Subscription from Group**: Removes an existing subscription from a subscription group.
- **Reopen Invoice**: Reopens any invoice with the "canceled" status.
- **Replay Webhooks**: Replays webhooks.
- **Resend Billing Portal Invitation**: Resends a customer's Billing Portal invitation.
- **Restore Component Feature**: Clears the archived state of a feature catalog item attached to this component.
- **Restore Feature Template**: Clears the feature template's archived state.
- **Restore Product Feature**: Clears the archived state of a feature catalog item attached to this product.
- **Resume Subscription**: Resumes a paused (on-hold) subscription.
- **Retry Subscription**: Retries collecting the balance due on a past-due subscription without waiting for the next scheduled attempt.
- **Revoke Billing Portal Access**: Revokes a customer's Billing Portal invitation.
- **Schedule Scheduled Renewal Lock In**: Schedules a future lock-in date for the renewal.
- **Send Invoice**: Sends an invoice to the customer via email.
- **Send Request Update Payment Email**: Sends a "request payment update" email to the customer associated with the subscription.
- **Signup with Subscription Group**: Creates multiple subscriptions at once under the same customer and consolidates them into a subscription group.
- **Unarchive Component Price Point**: Unarchives a component price point.
- **Unarchive Offer**: Unarchives a previously archived offer.
- **Unarchive Product Price Point**: Unarchives an archived product price point.
- **Unarchive Wallet Product**: Restores an archived Wallet Product.
- **Unpublish Scheduled Renewal Configuration**: Restores a scheduled renewal configuration to an editable state.
- **Update Automatic Subscription Resumption**: Updates the date on which a paused subscription will automatically resume.
- **Update Component**: Updates a component.
- **Update Component Feature**: Updates the value or periodicity of a feature catalog item attached to this component.
- **Update Component Price Point**: Updates a component price point and its associated prices.
- **Update Coupon**: Updates a coupon.
- **Update Coupon Subcodes**: Updates the subcodes for a coupon, replacing all existing subcodes with the new list.
- **Update Currency Prices**: Updates currency prices for a given currency defined at the site level.
- **Update Customer**: Updates the customer.
- **Update Customer Information**: Updates customer information on an open invoice and returns the updated invoice.
- **Update Endpoint**: Updates an Endpoint.
- **Update Feature Template**: Updates the name, description, unit, value type, default value, or default periodicity of a feature template.
- **Update Invoice**: Updates an ad hoc invoice while it is in the `draft` state.
- **Update Metadata**: Updates metadata and metafields on the Site and the customer or subscription specified, and updates the metadata value on a subscription or customer.
- **Update Metafield**: Updates metafields on your Site for a resource type.
- **Update Payment Profile**: Updates a payment profile.
- **Update Prepaid Subscription Configuration**: Updates a subscription's prepaid configuration.
- **Update Prepaid Usage Allocation Expiration Date**: Updates the expiration date for a prepaid usage allocation.
- **Update Product**: Updates aspects of an existing product.
- **Update Product Currency Prices**: Updates the `price`s of currency prices for a given currency that exists on the product price point.
- **Update Product Family Component**: Updates a component from a specific product family.
- **Update Product Feature**: Updates the value or periodicity of a feature catalog item attached to this product.
- **Update Product Price Point**: Updates a product price point.
- **Update Reason Code**: Updates an existing reason code for a given site.
- **Update Scheduled Renewal Configuration**: Updates an existing configuration.
- **Update Scheduled Renewal Configuration Item**: Updates an existing configuration item’s pricing and quantity.
- **Update Segment**: Updates a single segment for a component with a segmented metric.
- **Update Subscription**: Updates one or more attributes of a subscription.
- **Update Subscription Group Members**: Updates subscription group members.
- **Update Subscription Note**: Updates a note for a subscription.
- **Update Wallet**: Updates the wallet's editable attributes.
- **Update Wallet Product**: Updates the Wallet Product's catalog-facing fields.
- **Validate Coupon**: Verifies whether a specific coupon code is valid.
- **Validate Referral Code**: Validates whether a referral code is valid and applicable within your site.
- **Verify Bank Account**: Verifies a bank account.
- **Void Advance Invoice**: Voids a subscription's existing advance invoice.
- **Void Invoice**: Voids any invoice with the "open" or "canceled" status.
- **Void Proforma Invoice**: Voids a proforma invoice that has the status "draft".

Connect Maxio Advanced Billing in General Input: https://www.generalinput.com/apps/maxio