Subscription Plan API Documentation
Create and operate PayOrc subscription plans, contracts, subscribers, activation, cancellation, updates, and notifications.
Use this section to understand and implement PayOrc Subscription Plan capabilities through the relevant public integration flows and API references.
Subscription Plan Guides
Create Subscription Plan
Create a new subscription plan with billing frequency, installment amounts, terms, and payment details.
Update Subscription Plan
Update an existing subscription plan's details including billing frequency, installment amounts, terms, and scheduling.
Send Subscription Plan Email
Send subscription plan details to customers via email with customizable recipients, subject, and plan information.
Deactivate Subscription Plan
Deactivate an existing subscription plan to prevent new customer subscriptions.
Activate Subscription Plan
Activate a previously deactivated subscription plan to allow new customer subscriptions.
Get Subscription Plan Details
Retrieve detailed information about a specific subscription plan including billing, terms, and payment schedule.
List Subscription Plans
Retrieve and filter your subscription plans with pagination and various filter parameters.
Get Contract Details
Retrieve detailed information about a specific subscription contract including plan, subscriber, card, and payment data.
List Contracts
Retrieve a paginated list of subscription contracts with filtering by status, date, subscriber, and payment details.
Cancel Subscription
Cancel an active subscription to stop future billing for a subscriber.
Get Subscriber Details
Retrieve detailed information about a specific subscriber including contact details and payment history.
List Subscribers
Retrieve a paginated list of subscribers with optional filtering by email, mobile number, or subscriber ID.
Integration Guidance
- Authenticate requests only from a secure server environment.
- Validate required fields and supported values before sending each request.
- Store PayOrc and merchant references for status tracking and reconciliation.
- Confirm asynchronous outcomes through the documented webhook or status API where applicable.
- Exercise the complete flow with approved test credentials before production use.
Provider availability, credentials, and production enablement depend on merchant approval and the applicable PayOrc agreement.