Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Latest commit

 

History

History
165 lines (91 loc) · 4.16 KB

PlansApi.md

File metadata and controls

165 lines (91 loc) · 4.16 KB
Raw

\PlansApi

All URIs are relative to https://api.getlago.com/api/v1

Method HTTP request Description
create_plan POST /plans Create a new plan
destroy_plan DELETE /plans/{code} Delete a plan
find_all_plans GET /plans Find plans
find_plan GET /plans/{code} Find plan by code
update_plan PUT /plans/{code} Update an existing plan

create_plan

crate::models::Plan create_plan(plan_input) Create a new plan

Create a new plan

Parameters

Name Type Description Required Notes
plan_input PlanInput Plan payload [required]

Return type

crate::models::Plan

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

destroy_plan

crate::models::Plan destroy_plan(code) Delete a plan

Delete a plan

Parameters

Name Type Description Required Notes
code String Code of the existing plan [required]

Return type

crate::models::Plan

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_all_plans

crate::models::PlansPaginated find_all_plans(page, per_page) Find plans

Find all plans in certain organisation

Parameters

Name Type Description Required Notes
page Option<i32> Number of page
per_page Option<i32> Number of records per page

Return type

crate::models::PlansPaginated

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_plan

crate::models::Plan find_plan(code) Find plan by code

Return a single plan

Parameters

Name Type Description Required Notes
code String Code of the existing plan [required]

Return type

crate::models::Plan

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_plan

crate::models::Plan update_plan(code, plan_input) Update an existing plan

Update an existing plan by code

Parameters

Name Type Description Required Notes
code String Code of the existing plan [required]
plan_input PlanInput Update an existing plan [required]

Return type

crate::models::Plan

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]