> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Chargify (Maxio)

> How to set up the Chargify (Maxio) connector, plus the actions and events that are available.

![Chargify (Maxio)](https://stackone-logos.com/api/chargify/filled/svg)

v1.2.0[See changelog](https://docs.stackone.com/connectors/chargify/changelog.md)

[125 actions](#actions) · [50 events](#events) · 1 auth method

Billing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/chargify/guides/connector-profile/api-key.md)
>
> A Chargify (Maxio) API Key with admin access is required. A free sandbox is available for testing.

Optionally, configure receiving Events for Chargify (Maxio) into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/chargify/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/chargify/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

125 actions

ActionDescription

Enable Billing Portal`chargify_enable_billing_portal`

Enable the billing portal for a customer

Read Billing Portal Link`chargify_read_billing_portal_link`

Retrieve the billing portal management link for a customer

List Components`chargify_list_components`

Retrieve a list of all components across product families

Create Metered Component`chargify_create_metered_component`

Create a new metered component for a product family

Read Component`chargify_read_component`

Retrieve a single component by product family and component ID

Create Quantity-Based Component`chargify_create_quantity_component`

Create a new quantity-based component for a product family

Create On/Off Component`chargify_create_on_off_component`

Create a new on/off component for a product family

Update Component`chargify_update_component`

Update an existing component by ID

Archive Component`chargify_archive_component`

Archive a component by product family and component ID

List Coupons`chargify_list_coupons`

Retrieve a list of all coupons for the site

Create Coupon`chargify_create_coupon`

Create a new coupon for a product family

Update Coupon`chargify_update_coupon`

Update an existing coupon by ID

Archive Coupon`chargify_archive_coupon`

Archive an existing coupon by ID

Read Coupon`chargify_read_coupon`

Retrieve a single coupon by ID

Find Coupon`chargify_find_coupon`

Find a coupon by code

Validate Coupon`chargify_validate_coupon`

Validate whether a coupon code is valid

List Metafields`chargify_list_metafields`

Retrieve a paginated list of metafields for a resource type

List Metadata`chargify_list_metadata`

Retrieve a paginated list of metadata for a specific resource

List Metadata For Resource Type`chargify_list_metadata_for_resource_type`

Retrieve metadata values across all subscriptions or customers at once

Create Metafields`chargify_create_metafields`

Create metafields for a resource type

Update Metafield`chargify_update_metafield`

Update a metafield for a resource type

Delete Metafield`chargify_delete_metafield`

Delete a metafield for a resource type

Create Metadata`chargify_create_metadata`

Set named custom metadata key-value pairs on a specific subscription or customer

Update Metadata`chargify_update_metadata`

Update metadata for a specific resource

Delete Metadata`chargify_delete_metadata`

Delete metadata for a specific resource

List Customers`chargify_list_customers`

Retrieve a list of all customers

Read Customer`chargify_read_customer`

Retrieve a single customer by ID

Create Customer`chargify_create_customer`

Create a new customer

Update Customer`chargify_update_customer`

Update an existing customer by ID

Delete Customer`chargify_delete_customer`

Delete a customer by ID

Read Customer By Reference`chargify_read_customer_by_reference`

Look up a customer by their unique reference value

List Customer Subscriptions`chargify_list_customer_subscriptions`

Retrieve all subscriptions for a specific customer

List Events`chargify_list_events`

Retrieve a list of events for the site

List Subscription Events`chargify_list_subscription_events`

Retrieve a list of events for a specific subscription

List Invoices`chargify_list_invoices`

Retrieve a paginated list of invoices, including a subscription's invoices via the subscription\_id filter

Read Invoice`chargify_read_invoice`

Retrieve a single invoice by UID

Create Invoice`chargify_create_invoice`

Create a one-off invoice for a subscription

Void Invoice`chargify_void_invoice`

Void an invoice by UID

Refund Invoice`chargify_refund_invoice`

Issue a refund for an invoice by UID

Refund Invoice Consolidated`chargify_refund_invoice_consolidated`

Issue a refund for an invoice by UID

Record Payment For Invoice`chargify_record_payment_for_invoice`

Record a payment for an invoice by UID

Send Invoice`chargify_send_invoice`

Send an invoice to the customer via email

List Credit Notes`chargify_list_credit_notes`

Retrieve a paginated list of credit notes

Read Credit Note`chargify_read_credit_note`

Retrieve a single credit note by UID

List Invoice Events`chargify_list_invoice_events`

Retrieve a paginated list of invoice events

Record Payment For Multiple Invoices`chargify_record_payment_for_multiple_invoices`

Record a payment across multiple invoices

Reopen Invoice`chargify_reopen_invoice`

Reopen a previously voided or cancelled invoice

Issue Invoice`chargify_issue_invoice`

Issue a pending invoice by UID

Read Account Balances`chargify_read_account_balances`

Retrieve the account balances for a subscription

Create Prepayment`chargify_create_prepayment`

Record a prepayment on a subscription account via POST. This is the required action to actually record the prepayment.

List Prepayments`chargify_list_prepayments`

Retrieve a paginated list of prepayments for a subscription

List Service Credits`chargify_list_service_credits`

Retrieve a list of service credits for a subscription

Issue Service Credit`chargify_issue_service_credit`

Issue a service credit for a subscription

List Offers`chargify_list_offers`

Retrieve a paginated list of offers

Read Offer`chargify_read_offer`

Retrieve a single offer by ID

Create Offer`chargify_create_offer`

Create a new offer

Archive Offer`chargify_archive_offer`

Archive an existing offer

Unarchive Offer`chargify_unarchive_offer`

Unarchive a previously archived offer

List Payment Profiles`chargify_list_payment_profiles`

Retrieve a list of all payment profiles for the site

Read Payment Profile`chargify_read_payment_profile`

Retrieve a single payment profile by ID

Create Payment Profile`chargify_create_payment_profile`

Create a new payment profile for a customer

Update Payment Profile`chargify_update_payment_profile`

Update an existing payment profile by ID

Delete Unused Payment Profile`chargify_delete_unused_payment_profile`

Delete an unused payment profile by ID

List Products`chargify_list_products`

Retrieve a list of all products

Read Product`chargify_read_product`

Retrieve a single product by ID

Create Product`chargify_create_product`

Create a new product within a product family

Update Product`chargify_update_product`

Update an existing product by ID

Archive Product`chargify_archive_product`

Archive a product by ID

List Product Families`chargify_list_product_families`

Retrieve a list of all product families

Read Product Family`chargify_read_product_family`

Retrieve a single product family by ID

Create Product Family`chargify_create_product_family`

Create a new product family

List Product Price Points`chargify_list_product_price_points`

Retrieve a paginated list of price points for a product

Create Product Price Point`chargify_create_product_price_point`

Create a new price point for a product

Update Product Price Point`chargify_update_product_price_point`

Update an existing price point for a product

Read Product Price Point`chargify_read_product_price_point`

Retrieve a single price point for a product by ID

List Proforma Invoices`chargify_list_proforma_invoices`

Retrieve a paginated list of proforma invoices for a subscription

Create Proforma Invoice`chargify_create_proforma_invoice`

Create a proforma invoice for a subscription

List Reason Codes`chargify_list_reason_codes`

Retrieve a paginated list of reason codes for the site

Read Reason Code`chargify_read_reason_code`

Retrieve a single reason code by its ID

Create Reason Code`chargify_create_reason_code`

Create a new churn reason code

Update Reason Code`chargify_update_reason_code`

Update an existing churn reason code

Delete Reason Code`chargify_delete_reason_code`

Delete an existing churn reason code

Read Site`chargify_read_site`

Retrieve the current site details

List Subscription Components`chargify_list_subscription_components`

Retrieve a list of components associated with a subscription

Read Subscription Component`chargify_read_subscription_component`

Retrieve a single component associated with a subscription by its component ID (not the subscription-component instance...

Allocate Component`chargify_allocate_component`

Create an allocation for a component on a subscription

List Allocations`chargify_list_allocations`

Retrieve a list of allocations for a component on a subscription

Create Usage`chargify_create_usage`

Create a usage record for a metered component on a subscription

List Usages`chargify_list_usages`

Retrieve a list of usage records for a metered component on a subscription

List Subscription Groups`chargify_list_subscription_groups`

Retrieve a paginated list of subscription groups for the site

Read Subscription Group`chargify_read_subscription_group`

Retrieve a single subscription group by UID

Create Subscription Group`chargify_create_subscription_group`

Create a new subscription group

Delete Subscription Group`chargify_delete_subscription_group`

Delete a subscription group by UID

Find Subscription Group`chargify_find_subscription_group`

Find a subscription group by subscription ID

List Subscription Notes`chargify_list_subscription_notes`

Retrieve a paginated list of notes for a subscription

Create Subscription Note`chargify_create_subscription_note`

Create a new note for a subscription

Read Subscription Note`chargify_read_subscription_note`

Retrieve a single note for a subscription by ID

Update Subscription Note`chargify_update_subscription_note`

Update an existing note for a subscription

Delete Subscription Note`chargify_delete_subscription_note`

Delete a note from a subscription

List Subscriptions`chargify_list_subscriptions`

Retrieve a paginated list of all subscriptions for the site

Read Subscription`chargify_read_subscription`

Retrieve the details of a single subscription by its ID

Create Subscription`chargify_create_subscription`

Create a new subscription for a customer with a specified product

Update Subscription`chargify_update_subscription`

Update an existing subscription by its ID

Cancel Subscription`chargify_cancel_subscription`

Cancel an active subscription by its ID

Find Subscription`chargify_find_subscription`

Look up a subscription by its reference value

Reactivate Subscription`chargify_reactivate_subscription`

Reactivate a canceled or expired subscription

Pause Subscription`chargify_pause_subscription`

Place a subscription on hold to temporarily pause billing

Resume Subscription`chargify_resume_subscription`

Resume a paused subscription to restart billing

Activate Subscription`chargify_activate_subscription`

Activate a subscription that is in trialing, awaiting\_signup, or awaiting\_signup\_date state

Retry Subscription`chargify_retry_subscription`

Retry a failed subscription payment

Initiate Delayed Cancellation`chargify_initiate_delayed_cancellation`

Schedule a subscription for cancellation at the end of the current billing period

Cancel Delayed Cancellation`chargify_cancel_delayed_cancellation`

Remove a scheduled delayed cancellation from a subscription

Cancel Dunning`chargify_cancel_dunning`

Cancel the dunning process for a past-due subscription

Preview Subscription`chargify_preview_subscription`

Preview a new subscription before creating it

Preview Renewal`chargify_preview_renewal`

Preview the next renewal for a subscription

Apply Coupon To Subscription`chargify_apply_coupon_to_subscription`

Apply a coupon code to an existing subscription

Remove Coupon From Subscription`chargify_remove_coupon_from_subscription`

Remove a coupon from an existing subscription

Migrate Subscription Product`chargify_migrate_subscription_product`

Migrate a subscription to a different product or price point

Update Automatic Subscription Resumption`chargify_update_auto_resumption`

Update the automatic resumption date for a paused subscription

List Webhooks`chargify_list_webhooks`

Retrieve a list of webhooks for the site

List Endpoints`chargify_list_endpoints`

Returns created endpoints for a site.

Create Endpoint`chargify_create_endpoint`

Create a new webhook endpoint for the site.

Update Endpoint`chargify_update_endpoint`

Update an existing webhook endpoint for the site.

Replay Webhooks`chargify_replay_webhooks`

Replay webhook deliveries for the site.

Enable Webhooks`chargify_enable_webhooks`

Enable webhook endpoints for the site.

## Events

Tags

Select all
|
Clear

Components

Customers

Invoices

Payment Methods

Payments

Subscriptions

Webhooks

No tags found

50 events

EventDescriptionTags

Component Allocation Changed Webhook`chargify_webhook_component_allocation_change`

Processes Chargify (Maxio) component\_allocation\_change webhook events.

ComponentsWebhooks

Metered Usage Recorded Webhook`chargify_webhook_metered_usage`

Processes Chargify (Maxio) metered\_usage webhook events.

ComponentsWebhooks

Prepaid Usage Recorded Webhook`chargify_webhook_prepaid_usage`

Processes Chargify (Maxio) prepaid\_usage webhook events.

ComponentsWebhooks

Prepaid Subscription Balance Changed Webhook`chargify_webhook_prepaid_subscription_balance_changed`

Processes Chargify (Maxio) prepaid\_subscription\_balance\_changed webhook events.

ComponentsWebhooks

Customer Created Webhook`chargify_webhook_customer_create`

Processes Chargify (Maxio) customer\_create webhook events.

CustomersWebhooks

Customer Updated Webhook`chargify_webhook_customer_update`

Processes Chargify (Maxio) customer\_update webhook events.

CustomersWebhooks

Customer Deleted Webhook`chargify_webhook_customer_delete`

Processes Chargify (Maxio) customer\_delete webhook events.

CustomersWebhooks

Custom Field Value Changed Webhook`chargify_webhook_custom_field_value_change`

Processes Chargify (Maxio) custom\_field\_value\_change webhook events.

CustomersWebhooks

Invoice Issued Webhook`chargify_webhook_invoice_issued`

Processes Chargify (Maxio) invoice\_issued webhook events.

InvoicesWebhooks

Invoice Pending Webhook`chargify_webhook_invoice_pending`

Processes Chargify (Maxio) invoice\_pending webhook events.

InvoicesWebhooks

Proforma Invoice Issued Webhook`chargify_webhook_proforma_invoice_issued`

Processes Chargify (Maxio) proforma\_invoice\_issued webhook events.

InvoicesWebhooks

Statement Closed Webhook`chargify_webhook_statement_closed`

Processes Chargify (Maxio) statement\_closed webhook events.

InvoicesWebhooks

Statement Settled Webhook`chargify_webhook_statement_settled`

Processes Chargify (Maxio) statement\_settled webhook events.

InvoicesWebhooks

Subscription Card Updated Webhook`chargify_webhook_subscription_card_update`

Processes Chargify (Maxio) subscription\_card\_update webhook events.

Payment MethodsWebhooks

Subscription Bank Account Updated Webhook`chargify_webhook_subscription_bank_account_update`

Processes Chargify (Maxio) subscription\_bank\_account\_update webhook events.

Payment MethodsWebhooks

Subscription Group Card Updated Webhook`chargify_webhook_subscription_group_card_update`

Processes Chargify (Maxio) subscription\_group\_card\_update webhook events.

Payment MethodsWebhooks

Expiring Card Webhook`chargify_webhook_expiring_card`

Processes Chargify (Maxio) expiring\_card webhook events.

Payment MethodsWebhooks

Maxio.js Tokenization Succeeded Webhook`chargify_webhook_chjs_tokenization_success`

Processes Chargify (Maxio) chjs\_tokenization\_success webhook events.

Payment MethodsWebhooks

Maxio.js Tokenization Failed Webhook`chargify_webhook_chjs_tokenization_failure`

Processes Chargify (Maxio) chjs\_tokenization\_failure webhook events.

Payment MethodsWebhooks

3D Secure Authentication Failed Webhook`chargify_webhook_three_ds_authentication_failure`

Processes Chargify (Maxio) three\_ds\_authentication\_failure webhook events.

Payment MethodsWebhooks

Payment Succeeded Webhook`chargify_webhook_payment_success`

Processes Chargify (Maxio) payment\_success webhook events.

PaymentsWebhooks

Payment Failed Webhook`chargify_webhook_payment_failure`

Processes Chargify (Maxio) payment\_failure webhook events.

PaymentsWebhooks

Payment Not Attempted Webhook`chargify_webhook_payment_not_attempted`

Processes Chargify (Maxio) payment\_not\_attempted webhook events.

PaymentsWebhooks

Refund Succeeded Webhook`chargify_webhook_refund_success`

Processes Chargify (Maxio) refund\_success webhook events.

PaymentsWebhooks

Refund Failed Webhook`chargify_webhook_refund_failure`

Processes Chargify (Maxio) refund\_failure webhook events.

PaymentsWebhooks

Direct Debit Payment Pending Webhook`chargify_webhook_direct_debit_payment_pending`

Processes Chargify (Maxio) direct\_debit\_payment\_pending webhook events.

PaymentsWebhooks

Direct Debit Payment Paid Out Webhook`chargify_webhook_direct_debit_payment_paid_out`

Processes Chargify (Maxio) direct\_debit\_payment\_paid\_out webhook events.

PaymentsWebhooks

Direct Debit Payment Rejected Webhook`chargify_webhook_direct_debit_payment_rejected`

Processes Chargify (Maxio) direct\_debit\_payment\_rejected webhook events.

PaymentsWebhooks

Prepayment Balance Changed Webhook`chargify_webhook_prepayment_balance_changed`

Processes Chargify (Maxio) subscription\_prepayment\_account\_balance\_changed webhook events.

PaymentsWebhooks

Service Credit Balance Changed Webhook`chargify_webhook_service_credit_balance_changed`

Processes Chargify (Maxio) subscription\_service\_credit\_account\_balance\_changed webhook events.

PaymentsWebhooks

Signup Succeeded Webhook`chargify_webhook_signup_success`

Processes Chargify (Maxio) signup\_success webhook events.

SubscriptionsWebhooks

Signup Failed Webhook`chargify_webhook_signup_failure`

Processes Chargify (Maxio) signup\_failure webhook events.

SubscriptionsWebhooks

Delayed Signup Created Webhook`chargify_webhook_delayed_signup_creation_success`

Processes Chargify (Maxio) delayed\_signup\_creation\_success webhook events.

SubscriptionsWebhooks

Delayed Signup Failed Webhook`chargify_webhook_delayed_signup_creation_failure`

Processes Chargify (Maxio) delayed\_signup\_creation\_failure webhook events.

SubscriptionsWebhooks

Subscription State Changed Webhook`chargify_webhook_subscription_state_change`

Processes Chargify (Maxio) subscription\_state\_change webhook events.

SubscriptionsWebhooks

Subscription Product Changed Webhook`chargify_webhook_subscription_product_change`

Processes Chargify (Maxio) subscription\_product\_change webhook events.

SubscriptionsWebhooks

Subscription Product Change Scheduled Webhook`chargify_webhook_subscription_product_change_scheduled`

Processes Chargify (Maxio) subscription\_product\_change\_scheduled webhook events.

SubscriptionsWebhooks

Upgrade or Downgrade Succeeded Webhook`chargify_webhook_upgrade_downgrade_success`

Processes Chargify (Maxio) upgrade\_downgrade\_success webhook events.

SubscriptionsWebhooks

Upgrade or Downgrade Failed Webhook`chargify_webhook_upgrade_downgrade_failure`

Processes Chargify (Maxio) upgrade\_downgrade\_failure webhook events.

SubscriptionsWebhooks

Billing Date Changed Webhook`chargify_webhook_billing_date_change`

Processes Chargify (Maxio) billing\_date\_change webhook events.

SubscriptionsWebhooks

Expiration Date Changed Webhook`chargify_webhook_expiration_date_change`

Processes Chargify (Maxio) expiration\_date\_change webhook events.

SubscriptionsWebhooks

Pending Cancellation Changed Webhook`chargify_webhook_pending_cancellation_change`

Processes Chargify (Maxio) pending\_cancellation\_change webhook events.

SubscriptionsWebhooks

Price Point Changed Webhook`chargify_webhook_item_price_point_changed`

Processes Chargify (Maxio) item\_price\_point\_changed webhook events.

SubscriptionsWebhooks

Renewal Succeeded Webhook`chargify_webhook_renewal_success`

Processes Chargify (Maxio) renewal\_success webhook events.

SubscriptionsWebhooks

Renewal Failed Webhook`chargify_webhook_renewal_failure`

Processes Chargify (Maxio) renewal\_failure webhook events.

SubscriptionsWebhooks

Upcoming Renewal Notice Webhook`chargify_webhook_upcoming_renewal_notice`

Processes Chargify (Maxio) upcoming\_renewal\_notice webhook events.

SubscriptionsWebhooks

Trial End Notice Webhook`chargify_webhook_trial_end_notice`

Processes Chargify (Maxio) trial\_end\_notice webhook events.

SubscriptionsWebhooks

Dunning Step Reached Webhook`chargify_webhook_dunning_step_reached`

Processes Chargify (Maxio) dunning\_step\_reached webhook events.

SubscriptionsWebhooks

Subscription Group Signup Succeeded Webhook`chargify_webhook_subscription_group_signup_success`

Processes Chargify (Maxio) subscription\_group\_signup\_success webhook events.

SubscriptionsWebhooks

Subscription Group Signup Failed Webhook`chargify_webhook_subscription_group_signup_failure`

Processes Chargify (Maxio) subscription\_group\_signup\_failure webhook events.

SubscriptionsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.