Costs Endpoints

Route-level reference for MainWP REST API v2 Cost Tracker endpoints, including cost CRUD, related sites/clients lookups, and cost batch operations.

Use these endpoints to manage Cost Tracker entries in MainWP Dashboard.

Use the MainWP Postman collection as the source of truth for request and response schemas.

Cost endpoints require the built-in Cost Tracker module to be enabled.

Route Matrix

Method	Path	Purpose	Key Params
GET	/costs	List costs	page, per_page, search, include, exclude, status, category, type
POST, PUT, PATCH	/costs/add	Create a cost	name, price, payment_type, product_type, renewal_type, at least one of sites/groups/clients
GET	/costs/{id}	Get one cost	id
POST, PUT, PATCH	/costs/{id}/edit	Edit a cost	Same fields as add
DELETE	/costs/{id}/remove	Remove a cost	id
GET	/costs/{id}/sites	List sites linked to a cost	id
GET	/costs/{id}/clients	List clients linked to a cost	id
POST	/costs/batch	Batch cost create/update/delete	create[], update[], delete[]

---

Key Request Fields

Common write fields (create/edit):

• name, price, payment_type, license_type, product_type, product_slug
• renewal_type, last_renewal, payment_method, cost_tracker_status
• url, note, visual fields like product_color, icon_hidden
• Relationship selectors: sites, groups (tag IDs), and clients, each as a JSON array of integer IDs

At least one non-empty target set is required. You can combine sites, groups, and clients in the same request; all supplied selectors are saved and their linked sites are combined.

{
  "sites": [12],
  "groups": [3, 7],
  "clients": [4]
}

The example above shows only the relationship fields; include the other required cost fields when creating a cost. Use arrays, not comma-separated strings, for these selectors.

For /costs/{id} routes, the URL identifies the cost. A conflicting id in the body or query string does not redirect the operation to another cost. /costs/add always creates a new cost rather than updating a body-supplied id; batch updates identify their target through each item’s id.

---

Representative Requests

Create a cost

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name":"Hosting Plan",
    "price":49.00,
    "payment_type":"subscription",
    "product_type":"hosting",
    "renewal_type":"monthly",
    "sites":[12]
  }' \
  "https://your-dashboard.com/wp-json/mainwp/v2/costs/add"

{
  "success": 1,
  "data": {
    "id": 22,
    "name": "Hosting Plan"
  }
}

Remove a cost

curl -X DELETE \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://your-dashboard.com/wp-json/mainwp/v2/costs/22/remove"

{
  "success": 1,
  "message": "Cost deleted successfully."
}

---

Related Resources

• REST API Overview
• Clients Endpoints
• Sites Endpoints
• Batch Endpoint