WPBay API Update June 2026: Product Plans and plan_type

WPBay products can have one default plan or multiple custom plans, such as Basic, Pro, Agency, or any other plan created by the seller.

How it works

• plan_type identifies the product plan purchased by the customer.
• Products without custom plans use the default internal plan type: wpbay.
• Custom plans return their internal plan slug, for example basic, pro, or agency.
• Developer sandbox licenses currently return the default plan type: wpbay.
• Your plugin or theme can use plan_type to unlock plan-specific features.
• max_license_count controls how many sites can be activated. It is separate from plan_type.

Example

{
  "success": true,
  "plan_type": "pro",
  "message": "License successfully registered."
}

Keep wpbay as the backward-compatible default plan key in API integrations, even if the public seller-facing label is renamed in the WPBay interface.

1. License Registration Endpoint

HTTP Methods: GET POST

Purpose

Registers a license by verifying the purchase code, site URL, admin email, and API key. Performs ownership, sandbox, and license limit checks.

Request Parameters

Example Request

POST https://wpbay.com/api/purchase/v1/register
Content-Type: application/json

{
  "purchase_code": "ABC123-XYZ789-DEF456",
  "site_url": "https://example.com",
  "admin_email": "admin@example.com",
  "api_key": "your_api_key_here",
  "product_slug": "my-awesome-plugin",
  "developer_mode": "0"
}

Success Response

{
  "success": true,
  "plan_type": "pro",
  "message": "License successfully registered."
}

plan_type is the plan purchased by the customer. If the product does not use custom plans, the value will be wpbay.

If the same license is already registered for the same site, WPBay may return:

{
  "success": true,
  "plan_type": "pro",
  "message": "License already registered."
}

Common Errors

• missing_api_key → 403
• invalid_api_key → 403
• missing_purchase_code → 403
• missing_site_url → 403
• missing_product_slug → 403
• missing_admin_email → 403
• invalid_code → 400 Invalid purchase code
• invalid_product_id → 403 Product ID does not match the purchase code
• invalid_product_slug → 403 Product slug does not match the purchased product
• order_not_available → 400 Order refunded, cancelled, failed, or unavailable
• limit_reached → 403 License limit exceeded
• duplicate_entry → 409 License already registered for this site
• db_error → 500 Internal Error

2. License Revocation Endpoint

HTTP Methods: GET POST

Purpose

Revokes a registered license using the purchase code and site URL. Supports developer sandbox mode for testing.

Request Parameters

Example Request

POST https://wpbay.com/api/purchase/v1/revoke
Content-Type: application/json

{
  "purchase_code": "ABC123-XYZ789-DEF456",
  "site_url": "https://example.com",
  "api_key": "your_api_key_here",
  "product_slug": "my-awesome-plugin",
  "developer_mode": "0"
}

Success Response

{
  "success": true,
  "message": "License successfully revoked for site URL: https://example.com"
}

Common Errors

• missing_api_key → 403
• invalid_api_key → 403
• not_found → 404 No license found
• db_error → 500

3. Purchase Code Registration Check Endpoint

HTTP Methods: GET POST

Purpose

Checks if a purchase code is registered for a site URL. Supports sandbox mode.

Request Parameters

Example Request

POST https://wpbay.com/api/purchase/v1/registered
Content-Type: application/json

{
  "purchase_code": "ABC123-XYZ789-DEF456",
  "site_url": "https://example.com",
  "api_key": "your_api_key_here",
  "product_slug": "my-awesome-plugin",
  "developer_mode": "0"
}

Success Response

{
  "success": true,
  "status": "exists",
  "plan_type": "pro",
  "message": "This purchase code is registered."
}

plan_type is read from the active license registration. If older registration data does not contain a stored plan, WPBay falls back to the plan detected from the purchase code, or to wpbay.

Common Errors

• missing_api_key → 403
• invalid_api_key → 403
• missing_purchase_code → 403
• missing_site_url → 403
• invalid_purchase_code → 400
• not_found → 400 Not registered
• order_not_available → 400
• subscription_inactive → 400 Subscription is no longer active
• not_allowed → 400 Ownership mismatch

4. Purchase Code Verification Endpoint

HTTP Methods: GET POST

Purpose

Verifies the validity of a purchase code and returns order details. Supports sandbox mode.

Request Parameters

Example Request

POST https://wpbay.com/api/purchase/v1/verify
Content-Type: application/json

{
  "purchase_code": "ABC123-XYZ789-DEF456",
  "api_key": "your_api_key_here"
}

Success Response

{
  "order_id": 1234,
  "order_item_id": 5678,
  "product_id": 910,
  "product_title": "Your Product",
  "license_number": "LIC-00123",
  "max_license_count": "1",
  "plan_type": "pro",
  "order_status": "completed",
  "order_date": "2025-02-26 14:30:00",
  "billing_email": "customer@example.com",
  "customer_id": 1112
}

plan_type tells your integration which product plan was purchased.

max_license_count tells your integration how many site activations are allowed for the license. A value of 0 or d should be treated as unlimited by WPBay.

Common Errors

• missing_api_key → 403
• invalid_api_key → 403
• missing_purchase_code → 403
• invalid_purchase_code → 400
• order_not_available → 400
• subscription_inactive → 400 Subscription is no longer active
• not_allowed → 400 Ownership mismatch

5. Product Update Endpoint

HTTP Methods: POST

Purpose

Checks for product updates by comparing versions. Returns update details if available.

Request Parameters

Example Request

POST https://wpbay.com/api/update/v1/updates
Content-Type: application/json

{
  "purchase_code": "ABC123-XYZ789-DEF456",
  "product_slug": "my-awesome-plugin",
  "product_id": "123",
  "version": "1.0.0",
  "site_url": "https://example.com",
  "product_type": "plugin",
  "api_key": "your_api_key_here",
  "developer_mode": "0"
}

Success Response (Update Available)

{
  "new_version": "1.2.0",
  "download_url": "https://example.com/downloads/my_product_v1.2.0.zip",
  "changelog": "Bug fixes and performance improvements.",
  "release_date": "2025-03-01"
}

Common Errors

• no_version_info → 500
• invalid_code → 400

6. Product Info Endpoint

HTTP Methods: POST

Purpose

Returns detailed product information after validation.

Request Parameters

Example Request

POST https://wpbay.com/api/update/v1/info
Content-Type: application/json

{
  "purchase_code": "ABC123-XYZ789-DEF456",
  "product_slug": "my-awesome-plugin",
  "product_id": "123",
  "site_url": "https://example.com",
  "product_type": "plugin",
  "api_key": "your_api_key_here",
  "developer_mode": "0"
}

Success Response

{
  "name": "My Product",
  "version": "1.2.0",
  "description": "A detailed description of My Product.",
  "changelog": "List of updates and improvements...",
  "download_url": "https://example.com/downloads/my_product_v1.2.0.zip",
  "author": "Product Author",
  "support_url": "https://example.com/support"
}

Common Errors

• no_product_info → 500
• invalid_code → 400

7. Documentation Download Endpoint

HTTP Methods: GET

Purpose

Serves product documentation file if available.

Request Parameters

Example Request

GET https://wpbay.com/api/update/v1/docs_download?product_id=123

Success Response

File download (no JSON if successful).

Common Errors

• invalid_product → 403
• no_download → 404

8. Feedback Submit Endpoint

HTTP Methods: GET POST

Purpose

Submits product feedback. Not stored in sandbox mode.

Request Parameters

Example Request

POST https://wpbay.com/api/feedback/v1/submit
Content-Type: application/json

{
  "purchase_code": "ABC123-XYZ789-DEF456",
  "product_slug": "my-awesome-plugin",
  "product_id": "123",
  "reason": "I encountered performance issues.",
  "details": "The product slows down the site under heavy load.",
  "site_url": "https://example.com",
  "api_key": "your_api_key_here",
  "developer_mode": "0"
}

Success Response

{
  "success": true,
  "message": "Feedback successfully submitted."
}

Common Errors

• missing_reason → 400
• db_error → 500

9. Analytics Submit Endpoint

HTTP Methods: GET POST

Purpose

Submits analytics events. Not stored in sandbox.

Request Parameters

Example Request

POST https://wpbay.com/api/analytics/v1/submit
Content-Type: application/json

{
  "purchase_code": "ABC123-XYZ789-DEF456",
  "product_slug": "my-awesome-plugin",
  "events": [
    {
      "event_name": "activation",
      "timestamp": 1677628800,
      "wp_version": "5.8",
      "php_version": "7.4",
      "sdk_version": "1.0.0",
      "theme": "Twenty Twenty-One"
    }
  ],
  "site_url": "https://example.com",
  "api_key": "your_api_key_here",
  "developer_mode": "0"
}

Success Response

{
  "success": true,
  "message": "Analytics events successfully submitted."
}

Common Errors

• missing_events → 400
• db_error → 500

10. Upgrade List Endpoint

HTTP Methods: POST

Purpose

Lists available upgrade options and purchasable plans for a product.

Each item in data represents one available product variation / plan option. Use this endpoint if you want to display upgrade options inside your plugin or theme.

Request Parameters

Example Request

POST https://wpbay.com/api/upgrade/v1/list
Content-Type: application/json

{
  "product_id": 123
}

Success Response

{
  "success": true,
  "data": [
    {
      "id": 456,
      "name": "Monthly Access",
      "payment_price": "20",
      "display_price": "20$ / Monthly",
      "subscription_price": "20",
      "one_time_fee": "0",
      "subscription_interval": "1",
      "subscription": "Monthly",
      "license_count": "1",
      "plan_type": "basic"
    },
    {
      "id": 457,
      "name": "Yearly Access",
      "payment_price": "99",
      "display_price": "99$ / Yearly",
      "subscription_price": "99",
      "one_time_fee": "0",
      "subscription_interval": "1",
      "subscription": "Yearly",
      "license_count": "3",
      "plan_type": "pro"
    }
  ]
}

Response Fields

Common Errors

• no_upgrades_found → 404
• invalid_product_id → 404

11. Contact Form Submission Endpoint

HTTP Methods: POST

Purpose

Sends contact form messages to product author.

Request Parameters

Example Request

POST https://wpbay.com/api/contact/v1/submit
Content-Type: application/json

{
  "api_key": "your_api_key_here",
  "product_slug": "my-awesome-plugin",
  "product_id": "123",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "request_type": "Support",
  "summary": "Issue with product activation",
  "message": "I am experiencing difficulties activating the product on my site. Please advise."
}

Success Response

{
  "success": true,
  "message": "Your message has been sent successfully."
}

Common Errors

• missing_fields → 400
• email_failed → 500