API Reference
  1. Example User & Partner API
  2. Plan

Create a Plan for a Partner

post
https://{environment}.example.com/v1/api/partner//plans

Creates a new service plan for a specific partner. The plan can be restricted to specific user types (comma-separated). Basic authorization is required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 4 and 4

The partner's unique identifier (4 characters).

Body Params

Plan creation request.

string

Optional unique identifier. If omitted, one may be generated by the server.

string
required

A descriptive name for the plan.

string

Detailed description of the plan.

applicable_types
array of strings
required

A list of user types this plan applies to (e.g., "basic", "company", "advanced").

applicable_types*
Allowed:
Responses

400

Invalid request body or parameters

401

Unauthorized (Basic Auth required).

404

Partner not found.

500

Internal server error.

Updated over 1 year ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?