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.
• 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

#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.

Parameters: none.

Returns: each product with id, title, type, price, interval, status (draft or published) and the spaces it unlocks. 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?"

#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, R$ 450, in up to 3 installments, 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.

#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 R$ 390 monthly option with a 6-month contract and a R$ 3,900 annual option in up to 12 installments, 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. 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 R$ 129 to R$ 149."

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 R$ 50.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."

See Coupons.

#update_plan

Changes

Edit plan. Changes a plan's name, description, address, whether it is active, its billing options and its add-ons. 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.

#update_product

Changes

Edit product. Changes title, descriptions, the spaces it unlocks, stock, installments, free trial or direct link. Minimum role: admin.

Ask like this: "Raise the ticket's stock to 120."

Notes: the price is changed with update_price, which asks for confirmation.

#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 in the store."

See Store.

#Related

• Tools
• Recipes
• Money and confirmation