Soft delete (archive) a User account. This action is reversible.

Archive User

PATCH /v0/users/:userId/archive Request body

APIKEY 1 & APIKEY 2

PATCH /v0/users/:userId/archive Positive response

PATCH /v0/users/:userId/archive Negative response

Fungies

Introduction

Authentication

Retrieve a list of discounts with optional filtering and pagination.

Search discounts

Create a new discount with the specified details.

Create a new discount

Retrieve detailed information about a specific discount by its ID.

Get discount by ID

Update an existing discount with the specified details.

Update a discount

Archive a discount

Retrieve a list of offers with optional filtering and pagination.

Search offers

Create a new offer

Retrieve detailed information about a specific offer

Get offer details

Update an offer

Archive an offer

Add product keys

Remove unsold keys

Remove unsold key

Retrieve a list of orders with optional filtering and pagination.

List orders

Retrieve detailed information about a specific order by its ID or number.

Get order details

Modify an existing order's details. Requires write access.

Update order

Cancel a specific order by changing its status to CANCELLED. Requires write access.

Cancel order

Retrieve a list of payments with optional filtering and pagination.

List payments

Retrieve detailed information about a specific payment by its ID.

Get payment details

Retrieve a list of products with optional filtering and pagination.

Search products

Create a new product with the specified details.

Create a new product

Retrieve detailed information about a specific product by its ID.

Get product by ID

Archive a product

Update an existing product with the specified details.

Update a product

Duplicate a product

Add a new variant to an existing product.

Add a variant to a product

Update an existing variant with the specified details.

Update a variant

Archive a variant

Add a plan to a product

Update an existing plan with the specified details.

Update a plan

Archive a plan

Search and filter Subscriptions with pagination.
    Results are sorted by creation date (newest first) by default.

List Subscriptions

Create a new Subscription for a User.
    User must have a valid customer ID of Payment Provider set.
    Requires billing details with at least a country code and postal code if country is one of US, CA, UA, IN.
    
    Note: User must have a valid customer ID of Payment Provider set and this customer must have a valid default payment method set (Payment Provider dashboard).

Create Subscription

Retrieve detailed information about a specific Subscription.

Get Subscription

Update Subscription items and handle proration behavior.
    Can modify prices, quantities, and add/remove items.

Update Subscription

Charge an additional amount to an active Subscription.
    Creates a new Invoice and handles payment processing.

Charge Subscription

Cancel a Subscription with specified options for timing and refunds.

Cancel Subscription

Pause a Subscription's payment collection temporarily with options for handling payments.
    During the pause period:
    - No charges will be made
    - Access to subscription benefits will be maintained
    - Can be resumed manually or automatically at a specified time

Pause Subscription Collection

Retrieve a paginated list of Users with powerful filtering options.
    Results are sorted by creation date (newest first) by default.
    
    Note: Timestamps can be provided in either seconds or milliseconds since Unix epoch.

List and filter Users

Creates a new User account in the system. The email must be unique across all Users.
    Returns the created User object with all fields except the password.
    
    Note: If billingDetails are provided, ensure the countryCode is valid and postalCode is included for required countries.

Create a new User account

Get detailed information about a specific User.

Get User object

Update an existing User's data and billing details.

Update User details

Restore a User account that has been previously archived.

Unarchive User

Retrieve a complete list of items in the User's inventory with filtering options.
    This includes:
    - All purchased products
    - Subscription items
    - Limited-time access items
    
    Use filters to narrow down results by product type or expiration date.

Get User's inventory items

Create a new Checkout Element with offers

Create a new Checkout Element

Retrieve a list of checkout elements with pagination

List checkout elements

Event object

Order object

User object

Help Center

Discord

API v0 Reference

Core Resources

Developers

Dashboard

Receive Fungies events in your webhook endpoint.

Webhook endpoints

Learn how to set up a webhook to receive event data from Fungies.

Set up webhook

Test webhooks

Identify your users by collecting custom data and attributes.

Custom fields

Learn how to set up a custom field to collect additional information about your customers.

API v0 Documentation

discounts

offers

orders

payments

products

subscriptions

users

elements

Archive User

Authorizations

Path Parameters

Body

Response