← All action domains

Partnerships

5 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.

Pay for the partnership

partnerships.complete_purchasewriteconfirmadmin only

CHARGES THE CARD and, when it succeeds, makes the buyer a partner: a real recurring monthly subscription on Chirply's Stripe at the price reserved by 'partnerships.start_purchase', the paid entitlement applied, and THIS WORKSPACE PROMOTED out of its agency's client list into an independent agency of its own - it keeps every contact, funnel and campaign in it, gains the ability to brand itself and open client workspaces, and the agency that used to run it loses its access and is emailed to say so. Pass the Stripe ConfirmationToken the card form produced. If the bank asks for 3-D Secure the call returns 'requires_action' with a client secret, and the same capability is called again with no token once the browser has cleared it. Safe to call more than once — every step after the charge is idempotent.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
order_idstringrequiredThe order id returned by 'partnerships.start_purchase'.
confirmation_tokenstringoptionalThe Stripe ConfirmationToken id from the card form. Omit it only when re-calling after the browser completed a 3-D Secure challenge for a charge already submitted.

Example

curl -X POST https://app.chirply.io/api/v1/actions/partnerships.complete_purchase \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'
Test with your API key

Over MCP the same operation is the tool partnerships_complete_purchase at https://app.chirply.io/api/mcp, same bearer token, same input.

Partnerships you offer your clients

partnerships.get_selling_settingsreadadmin only

Report whether this white-label agency offers its client workspaces a Reseller or a White-Label partnership, what each costs the client, and the deal the agency earns on one — the commission percentage, whether it pays on every renewal or only the first payment, and how many months it runs for (0 meaning it never stops). All of it is read from the live rate table rather than fixed numbers. Both offers are off until an agency deliberately turns them on. Reads only: changes nothing and shows nothing to anybody.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/partnerships.get_selling_settings \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'
Test with your API key

Over MCP the same operation is the tool partnerships_get_selling_settings at https://app.chirply.io/api/mcp, same bearer token, same input.

Partnerships available to you

partnerships.list_offersread

List the partnerships this workspace can buy right now, with the monthly price of each, what it includes, and who bills it. These appear only in a workspace created by a white-label agency that has switched them on — the agency's client is buying a partnership with Chirply, the software company behind the platform, not with the agency: Chirply takes the payment on its own checkout and the agency is paid a referral commission. Returns an empty list, and no error, wherever there is nothing on offer. Reads only: charges nothing and changes nothing.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/partnerships.list_offers \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'
Test with your API key

Over MCP the same operation is the tool partnerships_list_offers at https://app.chirply.io/api/mcp, same bearer token, same input.

Save partnerships you offer

partnerships.set_selling_settingswriteconfirmadmin only

Decide whether this white-label agency's CLIENT accounts are shown the option to buy a Reseller or a White-Label partnership. THIS IS OUTWARD-FACING: switching one on puts an offer in front of the agency's own clients and tells those clients that Chirply exists and that they would be paying Chirply rather than the agency. It charges the agency nothing and earns them affiliate commission on every purchase. A client who buys is permanently credited to this agency — the attribution cannot be moved afterwards, and the commission is paid on every renewal for as long as that client keeps paying, whether or not they still use anything the agency sells them. It also MOVES THAT CLIENT OUT OF THE AGENCY: their workspace is promoted to an agency of its own, keeps all of its data, stops counting against the agency's client account limit, and the agency's access to it ends. The agency is emailed when that happens, and any subscription they were running for that client on their own Stripe is left untouched for them to cancel. Switching an offer back off hides it everywhere but never cancels, downgrades, or refunds a partnership somebody already bought, and commission already earned keeps paying.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
offer_white_labelbooleanrequiredShow client workspaces the $497/month White-Label Partnership — the whole platform under the client's own brand and domain.
offer_resellerbooleanrequiredShow client workspaces the $297/month Reseller Partnership — the client opens and bills client workspaces of their own.

Example

curl -X POST https://app.chirply.io/api/v1/actions/partnerships.set_selling_settings \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "offer_white_label": true,
    "offer_reseller": true
  }'
Test with your API key

Over MCP the same operation is the tool partnerships_set_selling_settings at https://app.chirply.io/api/mcp, same bearer token, same input.

Start a partnership purchase

partnerships.start_purchasewriteconfirmadmin only

Open a purchase of one of the partnerships from 'partnerships.list_offers' and get back the amount and the Stripe publishable key the card form needs. NOTHING IS CHARGED AND NOTHING IS CREATED IN STRIPE by this call - it records the intent and reserves the price, which the server computes itself. The price is NOT an argument: White-Label is $497 per month and Reseller is $297 per month, billed by Chirply on Chirply's own account, recurring until cancelled. Note what completing it does to this account: it is promoted out of the agency's client list into an independent agency of its own, keeping all of its data, and the agency that used to run it loses access. Only an owner or admin of the workspace who is NOT one of the agency's own people may do this. Pair it with 'partnerships.complete_purchase', which is the call that actually takes the money.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
tier"partner" | "reseller"requiredWhich partnership to buy. 'partner' is the White-Label Partnership (the whole platform under the buyer's own brand and domain); 'reseller' is the Reseller Partnership (the buyer opens and bills client accounts of their own). White-label includes everything reseller does.

Example

curl -X POST https://app.chirply.io/api/v1/actions/partnerships.start_purchase \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "tier": "partner"
  }'
Test with your API key

Over MCP the same operation is the tool partnerships_start_purchase at https://app.chirply.io/api/mcp, same bearer token, same input.

The machine-readable version of this page is GET https://app.chirply.io/api/v1/actions?domain=partnerships — same operations, with full JSON Schemas. Authentication, errors and rate limits are covered in the API documentation home.