API Reference

REST API Endpoints

Payges exposes a REST API under the /wp-json/payges/v1/ namespace. Authentication uses standard WordPress application passwords or cookie authentication.

WordPress Hooks

Payges provides action and filter hooks at every stage of the publishing pipeline. Key actions include payges_before_publish, payges_after_publish, payges_document_parsed, and payges_fields_mapped. Key filters include payges_field_mapping, payges_seo_metadata, and payges_template_config.

WP-CLI Commands

Payges includes WP-CLI commands for automated workflows. Use wp payges publish <file> to publish a document from the command line, wp payges batch <csv> for batch processing, and wp payges status to check your subscription and usage.

Webhook Events

Payges can send webhook notifications for key events: document published, batch completed, publishing failed, and subscription changes. Configure outgoing webhooks from the Payges settings panel.

PHP Helper Functions

Template helpers are available for theme developers: payges_get_plans() returns all active subscription plans, payges_get_subscription() returns the current user's subscription, and payges_get_page_image() retrieves replaceable page images.