Admin Create plan

Developing

POST

/admin/plans

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

object {0}

Example

{
    "name": "Premium Plan",
    "code": "PRM_PLN",
    "type": "public",
    "interval": "monthly",
    "currency": "USD",
    "description": "This is a Premium plan.",
    "amount": 20000,
    "trial_period_in_days": 5,
    "country": "US",
    "tax_rate": 2,
    "plan_matrix": "{\"Usage-based charges\":true,\"Add-ons\":true,\"Coupons\":true,\"Prepaid usage\":true, \"Tax management\":true, \"Billing webhooks\":true, \"PDF invoices\":true, \"Customer usage\":true}",
    "advance_payment": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://localhost:8080/v1/admin/plans' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Premium Plan",
    "code": "PRM_PLN",
    "type": "public",
    "interval": "monthly",
    "currency": "USD",
    "description": "This is a Premium plan.",
    "amount": 20000,
    "trial_period_in_days": 5,
    "country": "US",
    "tax_rate": 2,
    "plan_matrix": "{\"Usage-based charges\":true,\"Add-ons\":true,\"Coupons\":true,\"Prepaid usage\":true, \"Tax management\":true, \"Billing webhooks\":true, \"PDF invoices\":true, \"Customer usage\":true}",
    "advance_payment": false
}'

Responses

🟢200OK

application/json

Body

object {0}

Examples

SuccessSuccessSuccess

{"message":"plan created successfully","result":{"created_at":"2024-03-30T08:21:34.525711787Z","updated_at":"2024-03-30T08:21:34.525711847Z","name":"Basic Plan","code":"BSC_PLN","type":"public","interval":"monthly","currency":"USD","status":"active","external_plan_id":null,"description":"This is a basic plan.","amount":1000,"trial_period_in_days":14,"country":"US","tax_rate":5,"plan_matrix":"{\"key\":\"value\"}","deleted_at":null,"id":"dad08e78-50f9-4cb7-beb4-d75a9ccc040d","advance_payment":false},"success":true}

🟢200OK

Modified at 2024-03-31 09:43:05

Admin Get Plans

Admin Get Plan by ID