> For the complete documentation index, see [llms.txt](https://help.memberply.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.memberply.com/integrations/memberply-api.md).

# Memberply API and ChatGPT

The Memberply API is included with **Advanced, US$149/month**, and active **Enterprise** subscriptions. Advanced includes everything in Growth plus API access. Growth remains US$49/month. Both public plans include a 14-day trial for eligible new subscriptions. Mia inside Memberply remains available on Growth and does not require Advanced. See the [Mia guide](https://help.memberply.com/mia.md).

All merchants can see **Memberply API** under **Integrations**, marked **Advanced or Enterprise**. Select **Upgrade to Advanced**, choose Advanced on Shopify’s plan selection page and approve the subscription. New installations use the same Shopify page to choose Growth or Advanced. Returning to Memberply refreshes billing through the normal authenticated Shopify app launch.

API keys, REST requests and authenticated MCP/OAuth store access require a verified current Advanced or Enterprise subscription. A pending upgrade does not unlock access. A scheduled downgrade retains access while Advanced or Enterprise is still the current plan; access stops when Growth takes effect. Scheduled cancellation retains access only through the verified billing or trial end. Existing keys are denied after loss of access, although you can still view and revoke them in API connections while your merchant subscription remains active.

Shopify verification failures return HTTP `503` with `plan_verification_unavailable`; Growth or another plan without API access returns HTTP `403` with `advanced_plan_required`. No price, URL parameter, testing plan or cached billing grace grants API access. Advanced does not include the separate private Enterprise integrations.

The first Memberply API release supports reading your store's membership tiers and preparing new membership setup drafts. Drafts support one monthly, quarterly or yearly paid tier with any nonempty combination of percentage member discount, free shipping, sign-up store credit, birthday store credit, percentage cashback, Loyalty Drops, membership fees as store credit, reward points, spend-based discount levels, partner offers, member RSVP events, monthly free products, exclusive products and locked content. Publishing requires your review and approval inside Memberply.

It does not expose customer records, enrollment, billing, deletion, existing-tier editing or Memberply-wide reporting.

## Plan without a Memberply account

The public Memberply planning tools help you design a membership before connecting a store. No Memberply account, API key or purchase is needed. Public directory availability depends on OpenAI review and publication; a deployed MCP endpoint alone is not a directory listing.

Start with your audience and goal, then choose benefits you can fulfil. Ask for a monthly, quarterly or yearly membership blueprint. Leave the fee undecided if you need more time. The result includes benefits, remaining decisions, cost considerations and a launch checklist. It is a worksheet in your conversation, not a saved or published membership.

Example: “Help me plan a monthly membership for repeat customers with a member discount and free shipping. I have not decided the fee. Give me the settings and costs I need to work out.”

Public tools accept only a goal, benefit identifiers, cadence and an optional fee and currency. Do not send customer details, credentials or private store information. Memberply does not save these planning inputs in its application database or make an additional AI request to generate the worksheet. See the [plugin privacy disclosure](https://www.memberply.com/privacy#chatgpt-plugin).

### Continue in an existing Memberply store

When you explicitly ask to prepare a saved draft, connect an existing eligible account through OAuth. The current authenticated tools require Advanced or Enterprise. Review the requested tier, draft and catalog permissions inside Memberply. The connection lasts 24 hours; reconnect after expiry. Revoke it at **Integrations > Memberply API** whenever needed.

A public blueprint does not automatically become valid store configuration. The connected tools check your store currency, require complete benefit settings and search actual products/pages. After saving, open the returned review link, check all settings and approve inside Memberply. ChatGPT cannot publish for you, sell a membership, start a Memberply subscription, access customer records or edit live tiers.

The MCP server URL is `https://api.memberply.org/mcp`. Public discovery and the `get_membership_planning_guide` and `build_membership_blueprint` tools do not require authentication. Other tools require OAuth. Custom connections need an exact registered callback URL; contact support for connection setup if a directory listing is not yet available. Existing API keys cannot substitute for OAuth in MCP calls.

## REST API, MCP and Mia: what is the difference?

Memberply provides both a REST API and an MCP server. These are two ways for external software to use the supported membership setup features. Mia is the assistant inside Memberply and has a separate set of merchant tools.

| Option         | Who it is for                                               | Connection and capabilities                                                                                                                                                                                                                                                           |
| -------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **REST API**   | Developers connecting their own software to Memberply       | Uses a store-issued API key. Read supported tier and draft information, search the store catalog with permission, prepare new setup drafts and upload supported partner images.                                                                                                       |
| **MCP server** | An external AI assistant using Memberply's structured tools | MCP means Model Context Protocol. Public planning tools work without an account. Connected store tools use OAuth consent to read supported settings, tiers and drafts, search the store catalog with permission, and prepare or update new setup drafts. It has no image-upload tool. |
| **Mia**        | Merchants working inside Memberply                          | Uses your signed-in merchant session. Helps with supported membership setup and management, member operations and reports. It does not require an external API key or MCP connection.                                                                                                 |

The REST API and MCP server share the underlying setup services, store ownership checks and permission rules. Their available operations are not identical. An MCP connection does not grant access to Mia's broader merchant tools, customer records, billing or existing-tier editing. A store cannot access another store's information by supplying its ID.

**External API and MCP connections cannot approve or publish a membership.** They prepare a draft and return a review link. Open that link inside Memberply, review the saved settings and approve them before publication. An instruction in an external AI conversation does not replace this approval.

Mia can read supported information without a change approval. To apply a proposed change, use the merchant approval controls for that action. See [Mia's changes and approvals](https://help.memberply.com/mia/changes-and-approvals.md).

Use the REST API for a custom software integration, the MCP server for an AI connection, or Mia for assistance directly inside Memberply. The MCP endpoint is deployed, but this does not mean it is publicly listed or ready for unrestricted access. Follow the [ChatGPT connection setup](#chatgpt-connection-setup) requirements below.

## Create an API key

1. Open **Integrations > Memberply API > API connections** in Memberply. On Growth, select **Upgrade to Advanced** and complete Shopify approval first.
2. Enter a name that identifies the integration.
3. Keys can read tiers and drafts. Select draft editing only if needed. Select **Allow read-only product and page search** when the integration needs catalog lookup for monthly gifts, exclusive products or locked content.
4. Select **Create API key** and copy the key immediately. It is shown once.

Store the key in your server's secret settings. Never put it in browser JavaScript, a public repository or an AI conversation. Keys expire after 90 days. Create a replacement before expiry and revoke the old key after updating your integration. **Revoke** immediately disables a connection.

### Request limits and retries

External connections allow up to 60 requests per key per minute and 120 requests per store per minute across its keys and OAuth connections. Windows start with the first counted request. These limits are shared across API servers. Mia and the merchant setup screens have a separate store allowance, so external API traffic does not consume their request allowance. Mia's existing AI usage limits still apply.

MCP also returns HTTP `403`, `429` or `503` for permission, request-limit or availability failures. Tool validation errors remain MCP tool errors. Busy authentication checks can return `429` with a short retry delay; invalid-key attempts do not consume another store's minute allowance.

When a request returns HTTP `429`, wait for the number of seconds in `Retry-After` before retrying, when that header is present. Add a small random delay to avoid simultaneous retries. Daily draft and image limits require waiting for capacity to become available, rather than immediate retries. There can be at most 20 active API/OAuth credentials and 30 new setup drafts per store in a rolling 24 hours. Revoke unused connections before creating replacements when the credential limit is reached.

If the request-budget service is unavailable, protected requests return HTTP `503` with `request_budget_unavailable`. Retry with increasing delays. For draft creation retries, keep the original `Idempotency-Key` and request body. Additional service-wide abuse and concurrency protections can also reject requests. These limits are not an uptime guarantee or a promise of unlimited throughput.

### Temporary connection pauses

Repeated permission or request-limit violations can temporarily pause the affected API key or OAuth connection for 30 minutes. Requests then return HTTP `429` with `api_temporarily_paused` and a `Retry-After` header. Stop sending requests until that delay has passed, and correct the integration's permissions or request rate. Contact Memberply support if you need a review. Other keys and the merchant dashboard are not disabled by that credential's pause; store-wide request limits still apply.

## API reference

Base URL: `https://api.memberply.org/api/v1`

[OpenAPI specification](https://api.memberply.org/api/v1/openapi.json)

Send `Authorization: Bearer YOUR_KEY` and `Content-Type: application/json`. All resources belong to the store that issued the key. You cannot select another store by sending a store ID.

| Method | Path                                    | Scope          | Purpose                                                                             |
| ------ | --------------------------------------- | -------------- | ----------------------------------------------------------------------------------- |
| GET    | `/capabilities`                         | `tiers:read`   | Store currency and supported settings                                               |
| GET    | `/resources?purpose=gift&query=shampoo` | `catalog:read` | Search this store's product or page titles; refine the query when `hasMore` is true |
| GET    | `/tiers?after=0`                        | `tiers:read`   | Up to 50 tiers, with `nextCursor` for the next page                                 |
| POST   | `/setup-drafts`                         | `drafts:write` | Create a draft                                                                      |
| GET    | `/setup-drafts/{id}`                    | `tiers:read`   | Read a draft, state and review link                                                 |
| PUT    | `/setup-drafts/{id}`                    | `drafts:write` | Edit a draft using its current version                                              |

For draft creation, send a unique `Idempotency-Key` header of 8 to 100 letters, numbers, hyphens or underscores. Reuse the same key and original request body after a timeout. A different body with the same key returns `409`. Store the returned draft ID.

Example body, using a store whose currency is AUD:

```json
{
  "name": "VIP membership",
  "description": "Member savings and free shipping",
  "currency": "AUD",
  "frequency": "Monthly",
  "price": 20,
  "memberDiscountEnabled": true,
  "freeShippingEnabled": true,
  "signUpCreditAmount": null,
  "signUpCreditExpiryDays": null,
  "discountPercent": 10,
  "shippingMinimumPurchase": 0,
  "shipToAllCountries": false,
  "shippingCountries": ["AU"],
  "maximumShippingCost": null
}
```

The original fields remain required, including `null` for no shipping cap. Explicitly set `memberDiscountEnabled` and `freeShippingEnabled` in new integrations. For compatibility, omitted or null flags mean both original benefits stay enabled. Missing credit fields mean no credit. This preserves older draft settings and retries of original requests.

Select at least one benefit. When discount is disabled, send `discountPercent: 0`. When shipping is disabled, send `shippingMinimumPurchase: 0`, `shipToAllCountries: false`, `shippingCountries: []` and `maximumShippingCost: null`; the server clears unused values. When shipping is enabled, an empty country array is valid only for worldwide shipping.

`signUpCreditAmount` is a positive amount in store currency or `null` to disable credit. `signUpCreditExpiryDays` is 1 to 3650 whole days or `null` for no expiry. An expiry without a credit amount is rejected. Credit is limited to 100,000 store-currency units and US$10,000 equivalent. The currency limit is checked on save, approval and before creation; an unavailable conversion blocks credit setup. Credit follows the existing sign-up benefit delivery for new and legacy customer accounts, not recurring credit on renewal.

Additional optional fields:

| Field                      | Meaning                                                                                                                         |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `birthdayCreditAmount`     | Positive amount in store currency, or null to disable. Same amount and currency limits as sign-up credit.                       |
| `birthdayCreditExpiryDays` | 1 to 3650 whole days, or null for no expiry. Requires a birthday credit amount.                                                 |
| `cashbackPercent`          | Above 0 and up to 100, or null to disable. Credit on eligible merchandise, excluding tax and shipping, without product filters. |
| `cashbackMinimumPurchase`  | Positive minimum qualifying spend in store currency, or null for no minimum.                                                    |
| `cashbackMaximumPerOrder`  | Positive per-order cap in store currency, or null for no cap. A specified cap is limited to US$10,000 equivalent.               |
| `cashbackExpiryDays`       | 1 to 3650 whole days, or null for no expiry.                                                                                    |

Cashback settings require `cashbackPercent`. Monetary thresholds have at most two decimal places and are limited to 100,000 store-currency units. An omitted field is equivalent to null. Existing payloads remain compatible. Confirm expiry, minimum spend and cap with the merchant instead of silently assuming defaults. Birthday rewards require eligible members to have a recorded birthday. Cashback is credit, not a cash refund. Creating a draft or tier does not issue customer credit. The existing delivery flows support new and legacy customer accounts.

Recurring credit fields are also optional and preserve compatibility with older requests:

| Field                         | Meaning                                                                                                         |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `loyaltyDropAmount`           | Positive credit per drop in store currency, or null to disable. Maximum 100,000 units and US$10,000 equivalent. |
| `loyaltyDropIntervalMonths`   | Required with a drop amount. Integer from 1 to 12; independent of billing frequency.                            |
| `loyaltyDropExpiryDays`       | 1 to 3650 days, or null for no expiry. Requires a drop amount.                                                  |
| `feeCreditEnabled`            | True to return eligible membership payments as credit. Null or false disables it.                               |
| `feeCreditApplyOnFirstCharge` | Required explicit boolean when enabled: true includes the first payment; false starts with the second.          |
| `feeCreditExpiryDays`         | 1 to 3650 days, or null for no expiry. Requires fee credit enabled.                                             |

Disabled recurring benefits must have their dependent fields set to null or omitted. Fee credit validates the membership price against the US$10,000 equivalent limit on save, approval and before creation. Confirm the first-payment choice instead of silently assuming it. Loyalty Drops uses the existing schedule for active subscriptions; fee credit uses the existing payment flow. These are separate benefits and may issue additional credit when combined. Creating a draft or tier does not issue credit. Daily/weekly drop schedules, custom first-drop dates, partial fee conversion and fixed custom fee-credit amounts are not supported in this setup workflow.

Reward points and spend-based discounts are optional and can be selected alone or with other benefits:

| Field                      | Rule                                                                                                                                                                                                                                                                                  |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pointsPerCurrencyUnit`    | Whole points earned per store-currency unit, 1 to 10000. Null or omitted disables points.                                                                                                                                                                                             |
| `pointsPerCreditUnit`      | Whole points redeemed for one currency unit of credit, 1 to 10000. Required when points are selected.                                                                                                                                                                                 |
| `pointsCreditExpiryDays`   | Redeemed credit expiry, 1 to 3650 days or null for no expiry. Does not expire point balances.                                                                                                                                                                                         |
| `spendDiscountTiers`       | Array of 1 to 5 objects, each with required `name`, `threshold` and `discountPercent`. Null or omitted disables. Names must be unique, at most 60 characters. Thresholds must increase, above 0 up to 100000; percentages must increase, above 0 up to 100. Both accept two decimals. |
| `spendQualificationPeriod` | Required with spend discounts: `CalendarYear` or `Lifetime`.                                                                                                                                                                                                                          |
| `spendRefundsReduceTier`   | Required boolean with spend discounts: true allows refunds to reduce earned levels; false retains the highest earned level for the period.                                                                                                                                            |

Disable a benefit by clearing all of its dependent fields to null or omitting them. Unknown nested level fields, including membership-product identifiers, are rejected. Spend discounts count eligible post-joining spend only, excluding tax, shipping, membership purchases and store-credit-paid amounts. Calendar-year qualification resets each January in the store timezone; lifetime has no annual reset. A base member discount and spend discount use the greatest single saving, not added percentages. Mia does not configure historical spend imports, membership upgrades, fixed-amount levels or per-order minimums. Publishing verifies saved settings and synchronizes the Shopify discount before marking setup complete.

Points reuse existing purchase earning and member-initiated redemption in new and legacy customer accounts. No points or customer credit are issued when creating a draft or publishing a tier. See [reward points](https://help.memberply.com/creating-membership-benefits/reward-points-benefit.md) and [spend-tiered discounts](https://help.memberply.com/creating-membership-benefits/spend-tiered-discounts-benefit.md).

### Partner offers

Set `partnerOffers` to an array of 1 to 5 offers, or null/omit it to disable this benefit. Each offer must include all five fields:

| Field              | Rule                                                                |
| ------------------ | ------------------------------------------------------------------- |
| `partnerName`      | Required text, 1 to 100 characters.                                 |
| `offerDescription` | Required text, 1 to 300 characters.                                 |
| `howToRedeem`      | Required text, 1 to 1000 characters.                                |
| `offerInfo`        | Extra terms, up to 1000 characters, or explicitly null.             |
| `expiryDate`       | A real date formatted `YYYY-MM-DD`, or explicitly null for no date. |

Use merchant-supplied, agreed offer details. The API displays the offers in the existing new and legacy member areas. It does not create partner coupons, contact partners or automatically withdraw offers on the displayed date. Optional `logo` and `image` objects contain the exact `url` and `token` returned by `POST /images`; null or omission means no image. References are signed and store-bound, and checked again before publication. Record IDs and unknown nested fields are rejected. Use the normal benefit editor for availability changes. Partner offers can be the membership's only benefit, and publication still requires merchant approval. See [partner offers](https://help.memberply.com/creating-membership-benefits/partner-offers-benefit.md).

Unsupported fields are rejected. Prices, credit amounts and percentages accept at most two decimal places. Only selected benefits are created, and every change still requires merchant approval.

To update, send `{"version": 1, "spec": {...}}` to the draft URL. Use the actual version from the latest read. A stale version or approved draft returns `409`. Open the returned `reviewUrl` to approve the saved settings in Memberply. There is deliberately no public publish endpoint.

A draft progresses through `Draft`, `Queued`, `Creating`, `Configuring`, `Publishing` and `Complete`. Only `Complete` confirms publishing. `NeedsReview` requires support inspection before any retry. Poll no more frequently than every five seconds.

Errors return a `code` when handled by the application. `400` indicates invalid settings; `401` an invalid, expired or revoked key; `403` insufficient permission or inactive store access; `404` a draft unavailable to your store; `409` a conflict; `429` a limit; and `503` unavailable service. Allow for generic server or proxy errors. See [request limits and retries](#request-limits-and-retries) for the per-key and per-store allowances, daily quotas and retry guidance.

## ChatGPT connection setup

The public planning tools are available on the MCP endpoint. The plugin package has been uploaded, but connection testing and OpenAI review are still pending. For connected-store tools, register the Memberply connection and its exact OAuth callback URL before use. Endpoint availability does not mean the directory listing is published.

Connection settings:

* MCP URL: `https://api.memberply.org/mcp`
* Authentication: mixed anonymous planning and OAuth-protected store tools
* Client ID: `memberply-chatgpt`
* Client authentication: public client, no secret
* Scopes: `tiers:read drafts:write catalog:read`
* Resource: `https://api.memberply.org/mcp`
* Authorization code flow with PKCE S256

After registration, connect from ChatGPT, enter your Shopify store domain, select **Continue to Memberply**, sign in to Memberply and review the permission screen. The connection expires after 24 hours and can be revoked under **API connections**. Reconnect when it expires.

Ask ChatGPT to read your store's supported settings and prepare a membership draft. It should ask for missing settings and provide the Memberply review link. Review and publish there. API keys cannot be used as merchant login tokens or as a substitute for the MCP OAuth connection.

See [the setup and review workflow](https://help.memberply.com/mia/membership-setup-assistant.md).

## Member events, tickets and guests

Mia can prepare up to 5 member events while creating a new membership. Use this for a workshop, VIP evening or online session. Supply a title, description, start date and time, venue or joining details, optional end time, capacity (or unlimited) and whether to enable a waitlist. Waitlists require a capacity.

These events are visible to the new membership tier only. By default they use RSVP, with guests and event emails off. You can now select an existing Shopify member ticket product and choose no guests, complimentary guests or paid guests. Paid guests require an existing guest ticket product and Shopify draft-order permission. If that permission is missing, reconnect Memberply from Shopify and approve it before continuing.

Mia searches your store for ticket products. Confirm the exact products and the product changes before saving: **every variant of the selected member and guest ticket products becomes non-shipping**, and member ticket products gain members-only checkout protection. Existing eligible membership tiers keep access. Prices are unchanged. Use dedicated ticket products, not physical merchandise. A paid guest ticket must differ from the member ticket and any products selected for exclusive access.

Under **Event emails**, enable new-event announcements and up to three reminders using the existing templates. Reminder times are whole hours before the event, from 1 to 8760, entered largest to smallest without duplicates. These settings apply to all events in the new tier. Expand **Preview default email content** to review subjects and message bodies; actual emails also include existing store branding and member links. Publishing activates the selected settings using the existing recipient and attendance rules. Previewing does not send an email. Customize email copy separately in **Emails** after publication.

Mia does not create new ticket products, meeting links, recurring schedules or bookings, and cannot change existing events. The existing event and guest experiences work in Shopify new customer accounts and the legacy member dashboard. If publication stops, review any partially applied ticket-product changes before retrying.

Times use the existing Events editor's local wall-clock format without timezone conversion. Include the timezone in the venue or joining details so members know which time you mean. Review every date and time before approving.

Try: “Create Event Club for 20 monthly. Add a hair styling workshop on 20 January 2027 from 6pm to 7pm at our Perth studio, AWST. Capacity 20 with a waitlist. RSVP only for this tier, no guests or event emails. Ask for any missing details.” The price uses your store currency.

Set `events` to null/omit it to disable events, or an array of 1 to 5 objects. Every object requires these fields, including explicit nulls for optional values:

| Field             | Rule                                                                                      |
| ----------------- | ----------------------------------------------------------------------------------------- |
| `title`           | Nonblank text, up to 100 characters.                                                      |
| `description`     | Nonblank text, up to 2000 characters.                                                     |
| `startDateTime`   | Exact `YYYY-MM-DDTHH:mm`, without a timezone offset or Z.                                 |
| `endDateTime`     | Same format, strictly later than start, or null.                                          |
| `location`        | Venue or online joining details, up to 500 characters. Include the timezone in this text. |
| `capacity`        | Integer from 1 to 100000, or null for unlimited.                                          |
| `waitlistEnabled` | Boolean. True requires a capacity.                                                        |

Optional event fields are `ticketProduct` (resource object or null), `guestMode` (`disabled`, `complimentary` or `paid`), `guestProduct` (required only for paid guests), and `ticketChangesConfirmed` (must be true when either ticket is selected). Search `/resources?purpose=ticket` first, using the exact returned ID string and title. Obtain explicit merchant confirmation of the shipping and access changes before setting the confirmation field.

Top-level `eventEmails` is null/omitted for all emails off, or `{ "announcementEnabled": true, "reminderHours": [24, 3] }`. Both fields are required when the object is supplied. Events must be enabled. Unknown nested fields and record IDs are rejected. Events can be the only benefit. Publishing still requires merchant approval; a failed save or readback check stops publishing for review.

See [member events](https://help.memberply.com/creating-membership-benefits/events-benefit.md) for the full event editor and member experience.

## Monthly gifts, exclusive products and locked content

Mia can search the connected store's Shopify products and published pages. Describe the item you want, or ask Mia to find choices. It asks you to choose when matches are ambiguous. The review screen also has a search control for changing selections. It never creates products or pages for these benefits.

**Monthly free product:** choose a name, description, quantity from 1 to 100, and one product for each selected calendar month. Add between 1 and 12 months with no duplicates. The schedule repeats annually in the Shopify store timezone; unlisted months have no gift. Members claim through the existing monthly gift flow, with one claim per tier per calendar month. A product's variants are eligible under the existing rules. This does not ship products automatically or include free shipping. This Mia version selects individual products, not collections or specific variants. See [monthly free products](https://help.memberply.com/creating-membership-benefits/monthly-free-product-benefit.md).

**Exclusive product access:** select up to 20 individual products. These become members-only at checkout; existing eligible tiers can still grant access. Mia verifies checkout-protection synchronization during setup. Keep the Memberply theme component enabled for storefront messages; Mia does not install it. Collection selection remains in the normal benefit editor. See [exclusive product access](https://help.memberply.com/creating-membership-benefits/exclusive-product-access.md).

**Locked content access:** select up to 20 existing published Shopify pages. Install and enable the [Restricted Pages theme component](https://help.memberply.com/creating-membership-benefits/locked-content-access/restrict-non-members-from-accessing-locked-content.md), then test the page as a nonmember. Selecting pages through Mia alone does not guarantee protection. Mia does not install or verify theme gating, create pages, or gate external files and URLs. See [locked content access](https://help.memberply.com/creating-membership-benefits/locked-content-access.md).

Mia checks selected items against your store before saving, approval and publishing. Deleted, unavailable or renamed selections require another search and review. Access changes can affect existing storefront products and pages, so review every item before approving. If publishing is interrupted, some changes may already have been applied; inspect the setup before retrying.

Try: “Help me offer a monthly free product. Search my store and ask which product, calendar months and quantity to use.” Or: “Find the products I want to make members-only.” For content: “Find my member guide page and explain the theme setup before adding it.”

### Catalog search and payloads

Use `GET /api/v1/resources?purpose=gift&query=shampoo` with `catalog:read`, or the read-only MCP tool `search_store_resources` with `purpose` and `query`. Purposes are `gift`, `exclusive` and `content`. Query text is limited to 100 characters. Results contain `items` with string `id` and exact `title`, plus `hasMore`. Up to 20 matches are returned; refine the search when needed. No caller-supplied shop is accepted.

Optional setup fields:

* `monthlyGift`: null/omitted to disable, or `{ "name": "Monthly gift", "description": "Claim your monthly gift", "quantityLimit": 1, "schedules": [{ "monthOfYear": 1, "product": { "id": "ID_FROM_SEARCH", "title": "EXACT_TITLE_FROM_SEARCH" } }] }`. Names are limited to 100 characters, descriptions to 2000. Every nested field is required.
* `exclusiveProducts`: null/omitted, or 1 to 20 `{ "id": "ID_FROM_SEARCH", "title": "EXACT_TITLE_FROM_SEARCH" }` selections returned by `exclusive` search.
* `lockedPages`: null/omitted, or 1 to 20 equivalent selections returned by `content` search.

IDs are positive numeric strings, not Shopify GIDs. Do not invent IDs, titles or URLs. Extra nested properties and duplicate selections are rejected. The same gift product can be scheduled in multiple distinct months. Store ownership, availability and current titles are checked on the server; a rename returns `resource_changed`, an unavailable item returns `resource_unavailable`. Existing payloads remain compatible. Public API and MCP clients can prepare drafts but cannot approve or publish them.

Catalog search requires the separate `catalog:read` permission. Existing API keys do not gain this permission automatically. Enable the product/page search checkbox when creating a new key. ChatGPT OAuth registration must request `tiers:read drafts:write catalog:read`; reconnect to grant the additional scope.

## Partner image uploads

`POST /api/v1/images` requires `drafts:write`. Send `{ "data": "data:image/png;base64,..." }`. The image request body can be up to 2,900,000 bytes of JSON, including the base64 data. Other setup API requests retain a 65,536-byte body limit. The public endpoint accepts non-interlaced, 8-bit RGB or RGBA PNGs, at most 600 by 600 pixels and 2 MB decoded. The Memberply review UI also accepts JPEG/WebP and converts them before uploading. The server validates the PNG, removes metadata and returns `{ "url": "...", "token": "..." }`. Attach that complete object to an offer's `logo` or `image` field. Never invent or modify references, reuse another store's references, or supply arbitrary external URLs.

Uploads are public images, limited to 20 per store per rolling 24 hours, and do not save or publish a membership. Removing a reference does not delete the uploaded asset. Draft image references must be re-uploaded if the service signing key rotates. ChatGPT/MCP does not have an upload tool; upload through the API or open the draft review in Memberply. Existing draft payloads that omit these advanced fields keep their previous defaults.
