Create Billing Plan
POST/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.
Request​
Responses​
- 200
- 400
- 422
- 500
Billing plan details.
Standard error response returned when a request fails. Contains a machine-readable error code, a human-readable message.
Standard error response returned when a request fails.
Contains a machine-readable error code, a human-readable message,
and an errors object with field-specific validation issues.
Standard error response returned when a request fails. Contains a machine-readable error code, a human-readable message.