Tools · Sales and plans

What the community sells: plans with their billing options and add-ons, one-off products, coupons. Everything starts as a draft and only goes on sale when you ask; changing a price, creating or editing a coupon, creating or editing a last-chance offer and deleting ask for your yes, with a summary of the amounts. Changing a plan (update_plan) runs on the first call.

#Drafts before approval

You can set everything up before the business information is approved: products, options, plans, add-ons, coupons and downsell offers start as drafts and can be edited as much as you like. What waits for approval is publishing and selling:

• publish_product in a community without approval is refused with Memberfy's message: "To publish and start selling, the community needs approved business information. Meanwhile you can create and configure everything as a draft: fill it in under Settings › Business Information and submit it for review."
• In the composite tools (create_course, create_event and create_plan with publish), the refusal undoes nothing: the course, the event, the ticket, the plan and the options stay as drafts, the response gives the reason in publish_blocked, and the suggested next step is to fill in the business information and then publish with publish_product.
• If the approved country doesn't have a payment provider yet (today, only Brazil sells), publish_product is refused with Memberfy's explanation ("We don't sell in PT yet: the business information's country has no active payment provider."), and the composite tools keep everything as a draft, with the reason in publish_blocked.
• A draft's price is in the currency of the business information's country (in any status) or, without it, in reais. If the approved currency is a different one, publishing is refused ("This product is priced in …, but the approved business information uses …"): adjust the currency and the price first.

Each tool carries a badge: Read-only changes nothing, Changes creates or changes something right away, and Asks to confirm only acts after your yes to a summary. See Money and confirmation.

#In short

#Product kinds, free products and plans that include products

Who uses them: the owner and the admin create and delete products and build plans. Finance can now use update_product, update_price (with confirmation), publish_product and unpublish_product, and read list_products; the moderator only reads. Seats and the waitlist are in Tools · Courses.

#list_plans

Read-only

List plans. The community's plans, with each one's billing options and add-ons. Minimum role: admin or finance.

Parameters: none.

Returns: the plans (id, name, address), each plan's options (id, title, price, interval, status) and the add-ons.

Ask like this: "What plans do we have, and how much does each option cost?"

#list_products

Read-only

List billing options and products. All products: subscription options, one-time products, installment products and add-ons. Minimum role: admin or finance.

The response carries the pagination (total and pages); when there is more, the suggested next step is the next page.

Returns: each product with id, title, type, price, interval, status (draft or published), the spaces it unlocks and, on a product with stock, availability ("40 available" or "Sold out") and sold_out. The id is what create_plan (in add_on_ids), update_price, publish_product and create_coupon need.

Ask like this: "Which products are still drafts?"

Returns each product's pricing_mode (money, points, points_or_money) and points_price.

#list_coupons

Read-only

List coupons. The coupons, with status and usage. Minimum role: admin or finance.

Returns: the coupons, with code, type, value, duration, validity, limit and uses.

Ask like this: "Which coupons are active, and how many times has each been used?"

#create_product

Changes

Create billing option or product. Creates a product as a draft: a subscription option, a one-time product (ticket, course) or an installment product. Minimum role: admin.

Returns: the new product, as a draft, with its id.

Ask like this: "Create the product One-off mentoring, US$ 150, unlocking the Mentoring space. Leave it as a draft."

Notes: nothing is sold until publish_product, and creating doesn't depend on approved business information (see Drafts before approval). For a plan with several options, create_plan does it all at once. Each field follows the same rules as in the dashboard: see Products and Billing options. An image that can't be used stops the tool before anything changes; if the upload fails after creating, the product is undone.

pricing_mode (money, points or points_or_money) and points_price give a points price to a one-time product (digital, physical, event, course or download). See Points in the Store.

#create_plan

Changes

Create plan with options and add-ons. Billing options → plan with the options → linked add-ons. Minimum role: admin.

Each option:

Returns: the plan (id, name, address), the options (id, title, price, interval, status) and the linked add-ons.

Ask like this: "Create the Mentoring plan with a US$ 90 monthly option with a 6-month contract and a US$ 900 annual option, both unlocking the Mentoring space, and link One-on-one session as an add-on."

Notes: if a step fails, the plan is undone last, because Memberfy won't delete a plan that still has options. A plan has no image of its own: the top-level images go to every option (an option's own win for it). An image that can't be used doesn't undo the plan: the rest is created and the reason comes back in warnings. See Plans, Add-ons and Annual in installments.

#publish_product

Changes

Publish product (put on sale). Puts a draft product on sale. Minimum role: admin.

Returns: the product, published.

Ask like this: "Go ahead and publish the Excel from Scratch product."

Notes: publishing requires approved business information, and the product in the approved country's currency. Without that, Memberfy refuses and the product stays a draft, editable. See Drafts before approval.

#unpublish_product

Changes

Take product off sale. Takes a product off sale. Anyone who already bought it keeps access. Minimum role: admin.

Returns: the product, off sale.

Ask like this: "Take the October meetup ticket off sale."

#update_price

Asks to confirm

Change a product's price. Changes the price of a product or billing option. Minimum role: admin.

The summary: the product, the current price, the new price and the status (draft or published).

Ask like this: "Raise Growth Monthly from US$ 25 to US$ 29."

Notes: existing subscriptions follow Memberfy's rules for price changes, the same as editing in the dashboard. See Billing options.

#create_coupon

Asks to confirm

Create coupon. Creates a discount coupon, a percentage or a fixed amount, for all products or only some. Minimum role: admin.

The summary: the action, the code, the discount (20% or US$ 10.00), the duration, the usage limit, the validity and the products.

Ask like this: "Create the coupon BLACK30, 30% on the first charge only, for the Growth plans, up to 100 uses, valid until 11/30."

To give a plan away for free, the coupon must be 100% with duration FOREVER: with ONCE or REPEATING, checkout refuses the plan. See 100% coupon.

See Coupons.

#update_plan

Changes

Edit plan. Changes a plan's name, description, address, whether it is active, its billing options, its add-ons and its images. Minimum role: admin.

Ask like this: "Remove the annual option from the Growth plan and keep only the monthly."

Notes: it changes what is sold right away, without confirmation. Prices change with update_price, which asks for your yes. A plan has no image of its own: to change the image of a single option, use update_product on it. An invalid image for the plan is checked before anything changes; an upload refused for one option comes back in warnings.

#update_product

Changes

Edit product. Changes title, descriptions, the spaces it unlocks, stock, installments, free trial, direct link or images — including those of a plan's billing option. Minimum role: admin.

Ask like this: "Raise the ticket's stock to 120." · "Swap the course banner for the image https://…/new-banner.png."

Notes: the price is changed with update_price, which asks for confirmation. An image that can't be used changes nothing: the tool stops first, with the reason.

Takes pricing_mode and points_price, as create_product.

#update_products

Changes

Edit several products. Applies to up to 20 products, in a single call, the same changes as update_product — title, descriptions, spaces, stock, installments, trial, direct link and images — and also the price. A plan's billing option counts as a product here. Minimum role: admin.

How it works: if any item changes the price, the first call changes nothing: it returns the summary (each item's current and new price, and what else changes) and a code. Show the summary, wait for your yes and repeat the call with the same arguments and the confirmation_token. With no price in the batch, it runs on the first call.

Returns: the result item by item (updated, or the error), and how many succeeded and how many failed. An item with an error doesn't stop the others. An image that can't be used fails only that item, before it changes; an upload refused afterwards comes back in the item's warning. If an item is still a draft, the suggested next step is to publish it.

Ask like this: "Swap the banner of the three one-off courses for these images." · "Raise the ticket stock to 120 and the Workshop price to US$ 180."

#update_plans

Changes

Edit several plans. Applies to up to 20 plans, in a single call, the changes of update_plan: name, description, address, active, visibility (Public or Link only), the list of options, the list of add-ons and the images, which go to every option of the plan. Minimum role: admin.

Returns: the result item by item, as in update_products. It doesn't touch money (prices go through update_products or update_price), so it runs on the first call, without confirmation.

Ask like this: "Make the Invite and Partners plans Link only."

#update_coupon_status

Asks to confirm

Pause or reactivate coupon. Pauses or reactivates a coupon. Minimum role: admin.

Ask like this: "Pause the BLACK30 coupon."

#update_coupon

Asks to confirm

Edit coupon. Changes an existing coupon. Only what is sent changes; pausing is done with update_coupon_status. Minimum role: admin.

Returns: on the first call, the code and what changes, and the confirmation code.

Ask like this: "Raise BLACK30 to 40% and extend it until Sunday."

See Coupons.

#delete_coupon

Asks to confirm

Delete coupon. Discounts already given remain valid. Minimum role: admin.

Returns: on the first call, the code and how many times it was used, and the confirmation code.

#get_coupon_usage

Read-only

View coupon usage. Who used it, when and how much discount. Minimum role: admin or finance.

Ask like this: "Who used the BLACK30 coupon?"

#list_downsell_offers

Read-only

A plan's downsell offers. The discount offers on add-ons after a plan is bought, with how many times they were shown and converted. Minimum role: admin.

Ask like this: "How well does the last-chance offer for the Coworking Extension convert?"

#create_downsell_offer

Asks to confirm

Create downsell offer. Creates a discount offer on an add-on, shown after the plan is paid. Minimum role: admin.

Ask like this: "Offer 30% off the Coworking Extension to people who subscribe to Growth without it, for the first 3 charges."

See Downsell.

#update_downsell_offer

Asks to confirm

Edit downsell offer. Changes a plan's last-chance offer, or pauses it. Only what is sent changes. Minimum role: admin.

Ask like this: "Pause the Coworking Extension offer until the end of the month."

#delete_downsell_offer

Asks to confirm

Delete downsell offer. Minimum role: admin.

#delete_product

Asks to confirm

Delete product. Deletes a product or a billing option. Whoever bought it keeps access. Minimum role: admin.

Returns: on the first call, the title, the price and the status, and the confirmation code.

Notes: to just stop selling, prefer unpublish_product. See Products.

#delete_plan

Asks to confirm

Delete plan. Existing subscribers aren't canceled. Minimum role: admin.

Returns: on the first call, the plan's name and its options, and the confirmation code.

#reorder_plans

Changes

Reorder plans. Puts the plans in a new order on the pricing page, from first to last. Minimum role: admin.

Ask like this: "On the pricing page, put Growth before Starter."

#get_storefront

Read-only

View store. What a Store space shows: all products or only the chosen ones. Minimum role: admin.

#update_storefront

Changes

Choose the store's products. Sets what a Store space sells. Minimum role: admin.

Ask like this: "Leave only the one-off courses and the Growth plan in the store."

Notes: each list replaces its own part of the selection, in the order sent; when omitted, that part stays as it is; when empty ([]), it is cleared. A Link only plan is kept, but doesn't show in the storefront.

See Store.

#list_storefront_products

Read-only

Store products. The products a Store space sells, as you see them. Minimum role: any.

Returns: the Store's three groups: the products (price, installments, billing, sold_out (sold out, without the count), highlighted and the plans they require), the plans (each one once, with the "from" price) and the add-ons, each with its state for whoever is asking (You already have it, Add, Available on the X plan or Subscribe to the X plan). The suggested next step follows the state: manage the subscription, add the add-on, ask for the plan-change quote or open the plan page.

Ask like this: "What's on sale in the Store?"

Notes: a product that requires a plan you don't have is left out, unless you manage the Store. Which products the Store sells is get_storefront and update_storefront.

#Paying with points

When the community uses points as currency, a product can have a points price (pricing_mode and points_price in create_product and update_product).

#redeem_product_with_points

Asks to confirm

Redeem with points. Spends your points balance on a product priced in points (pricing_mode points or points_or_money in list_products or the Store), one unit per redemption. Nothing is charged: the purchase is born completed, paid with points, and access comes at once. Refusals in the API's words: not enough balance (with how many points are missing), the balance or gamification off, sold out or already owned, a product you cannot buy. Points are never bought, turned into money or transferred. Asks to confirm, with the price and the balance before and after. Minimum role: any.

Ask like this: "Trade my points for the community T-shirt."

Notes: the shipping address is masked in the assistant's log.

#Related

• Tools
• Recipes
• Money and confirmation