API Reference
- Customers
- Products
- Plans
- Contracts
- Invoices
- Measurements
- Auth
- Events
- Reports
- Integrations
- Credits
- Webhooks
Create Plan
Create a new Plan.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The billing data of the plan. The billing data contains the billing interval, the plan duration the payment terms and auto renewal, and the billing method.
Monthly, BiMonthly, Quarterly, SixMonths, Yearly x > 0flag to indicate if the payment is postpayment or prepayment
Prepayment, Postpayment The name of the plan
1The products of the plan
Monthly, BiMonthly, Quarterly, SixMonths, Yearly flag to indicate if the payment is postpayment or prepayment
Prepayment, Postpayment 1The pricing data of the meter. The pricing data contains the pricing model and the pricing details.
PerUnit 1x > 01The status of the plan. plan statuses are active, inactive
Active, Inactive, Error 1The purchase order number
20Response
The billing data of the plan. The billing data contains the billing interval, the plan duration the payment terms and auto renewal, and the billing method.
Monthly, BiMonthly, Quarterly, SixMonths, Yearly x > 0flag to indicate if the payment is postpayment or prepayment
Prepayment, Postpayment The name of the plan
1The products of the plan
Monthly, BiMonthly, Quarterly, SixMonths, Yearly flag to indicate if the payment is postpayment or prepayment
Prepayment, Postpayment 11x > 01The status of the plan. plan statuses are active, inactive
Active, Inactive, Error The plan ID that this plan is based on
The description of the plan
1The purchase order number
20