For providers / Feed format

Partner Feed v1 format

Publish a JSON file on your domain, ideally at /.well-known/cloudmac.json, and make it publicly readable over HTTPS. We read connected feeds daily. See the complete JSON Schema, then check your file with the browser validator.

Rules

Include only current, factual information. Omit optional fields when the value is unknown.
Keep each offers[].id stable. Price history is tied to that ID.
Use the price, currency and billing period shown on your website. Put any mandatory percentage fee in surcharge_pct.
Large price changes and new locations may be reviewed before publication. Persistent differences from your website can lead to removal of the direct-feed badge.

Fields

Field	Requirement	Description
`version`	Required	Always "1"
`updated_at`	Required	Last file update, YYYY-MM-DD
`provider.name / website`	Required	Brand name and official website
`provider.contact`	Optional	email / telegram / wechat
`provider.support_languages`	Optional	Support languages, such as ["en","zh"]
`provider.payment_methods`	Optional	card / paypal / alipay / wechat / usdt / crypto / bank
`provider.trial`	Optional	Trial or refund policy in one sentence
`provider.trial_en`	Optional	English trial or refund policy when provider.trial uses another language
`offers[]`	Required	Every currently available plan; removing a plan marks it as withdrawn
`offers[].id`	Required	Stable lowercase ID using letters, numbers and hyphens; do not change it later
`offers[].service_type`	Required	dedicated / vps / shared / colo / ci
`offers[].hardware`	Required	family (mac-mini / mac-studio / mac-pro / vm), chip, ram_gb and storage_gb; cpu_cores and gpu_cores are optional
`offers[].locations[]`	Required	Two-letter country code (JP, SG, US…), with optional city
`offers[].network`	Optional	bandwidth_mbps, traffic_tb (null means unlimited), ipv4, ip_type (residential / isp / datacenter), ip_dedicated
`offers[].access`	Optional	root, ssh, vnc, uu_remote, rustdesk, kvm, custom_software, reinstall; true / false
`offers[].prices[]`	Required	amount, currency and period (hour / day / week / month / quarter / year); vat_included, setup_fee, surcharge_pct, min_term_months, note and note_en are optional
`offers[].stock`	Required	in_stock / sold_out / coming_soon / unknown
`offers[].url`	Optional	Plan order page
`deals[]`	Optional	Promotions: id, title, code, url, starts_at, expires_at
`affiliate`	Optional	Referral URL and terms

Example

Download the example file

{
  "version": "1",
  "updated_at": "2026-10-19",
  "provider": {
    "name": "Example Mac Cloud",
    "website": "https://example.com/",
    "contact": { "email": "[email protected]", "telegram": "@example" },
    "support_languages": ["en", "zh"],
    "payment_methods": ["card", "paypal", "usdt"],
    "trial": "Refund available within the first 7 days"
  },
  "offers": [
    {
      "id": "m4-16-256",
      "name": "Mac mini M4 Standard",
      "service_type": "dedicated",
      "hardware": { "family": "mac-mini", "chip": "M4", "cpu_cores": 10, "gpu_cores": 10, "ram_gb": 16, "storage_gb": 256 },
      "network": { "bandwidth_mbps": 1000, "traffic_tb": null, "ipv4": true, "ip_type": "datacenter", "ip_dedicated": true },
      "locations": [{ "country": "JP", "city": "Tokyo" }, { "country": "SG" }],
      "access": { "root": true, "ssh": true, "vnc": true, "custom_software": true },
      "prices": [
        { "amount": 99, "currency": "USD", "period": "month", "vat_included": false },
        { "amount": 6, "currency": "USD", "period": "day", "vat_included": false }
      ],
      "stock": "in_stock",
      "url": "https://example.com/order/m4"
    }
  ],
  "deals": [
    { "id": "launch-offer", "title": "20% off the first month", "code": "CM20", "url": "https://example.com/promo", "expires_at": "2026-11-12" }
  ],
  "affiliate": { "url": "https://example.com/?aff=cloudmac", "terms": "20% of the first payment" }
}