Skip to main content
Source: equa-server/modules/api/src/endpoints/billing-endpoints.ts

Billing Endpoints

Endpoints for managing subscriptions, payment profiles, and billing operations. Equa uses Chargify (Maxio) as the billing provider. All billing data is accessed through the Chargify API via these server-side endpoints. All billing endpoints require authentication. Most require canEditOrganizationBilling or canEditEntityBilling permission.

Products

List Products

List all available Chargify product plans.

Get Member Pricing

Get the pricing tiers for member-based billing components.

Subscriptions

Get Organization Subscriptions

List all subscriptions for an organization.

Create Subscription

Create a new subscription for an organization.

Preview Subscription

Preview the cost of a subscription purchase before committing.

Cancel Subscription

Cancel an organization’s subscription.

Get Organization Features

Get the feature set enabled for the organization based on its subscription plan.

Get Transactions

List billing transactions for an organization.

Promo Codes

Validate Promo Code

Validate a promotional code and return discount details. Request:

Payment Profiles

Payment profiles are now scoped to entities (not organizations). The organization-scoped endpoints are deprecated.

Create Payment Profile

Create a new payment profile (credit card or bank account) for an entity.

List Payment Profiles

List all payment profiles for an entity.

Update Payment Profile


Set Default Payment Profile

Set a payment profile as the default for the entity.

Delete Payment Profile


Adjustments

Create Adjustment

Create a billing adjustment on a subscription (credits, charges).