Plans
Get Plan
API Reference
- Customers
- Products
- Plans
- Contracts
- Invoices
- Measurements
- Auth
- Events
- Reports
- Integrations
- Credits
- Webhooks
Plans
Get Plan
Get a Plan by id.
GET
/
plans
/
{planId}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
200 - application/json
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.
Available options:
Monthly, BiMonthly, Quarterly, SixMonths, Yearly Required range:
x > 0flag to indicate if the payment is postpayment or prepayment
Available options:
Prepayment, Postpayment The name of the plan
Minimum length:
1The products of the plan
Available options:
Monthly, BiMonthly, Quarterly, SixMonths, Yearly flag to indicate if the payment is postpayment or prepayment
Available options:
Prepayment, Postpayment Minimum length:
1Minimum length:
1Required range:
x > 0Minimum length:
1The status of the plan. plan statuses are active, inactive
Available options:
Active, Inactive, Error The plan ID that this plan is based on
The description of the plan
Minimum length:
1The purchase order number
Maximum length:
20