API Explorer
Explore and run ePay API requests with an interactive request builder for the ePay Payments API.
API category
Endpoint
POST1.0.0
Create Billing Plan
/public/api/v1/subscriptions/billing/plans
Creates a new billing plan. Billing plans are the basis of all billing agreements with automatic charges.
Relationship to other components
- Subscription: The underlying link between a merchant and a stored payment method. Created via the Initialize Payment Session
/citendpoint by sending the Subscription object. - Billing Plan: Defines recurring details like price, interval, and retry policy. Used only when ePay manages the billing schedule automatically.
- Billing Agreement: Connects a Subscription to a Billing Plan. Tracks scheduled processing and charge lifecycle.
- Billing Agreement Charge: Represents a scheduled billing event created from an agreement. Each charge can have multiple transaction attempts and a completion deadline.
- Transaction: The base payment model used for all processing. Charges and transactions are linked to maintain attempt history.
Authentication
Paste a key, or log in to ePay test.
Request body
string
integer
string
integer
object
string
integer