API Reference

Account Manipulation

get deprecated
https://api.vcita.biz/v1/partners/accounts//change_package

Deprecated

This endpoint is deprecated. Package and billing management is now handled by the Subscription API. Please migrate all integrations to use the Subscription API endpoints for package changes, billing updates, and subscription management.

Overview

Update billing info and/or package to an existing account under your directory.

Available for Directory tokens only.

Authentication

Uses HTTP Token authentication. Format: Authorization: Token token="{DIRECTORY_TOKEN}"

The token must be a Doorkeeper OAuth token with directory scope.

Note: The business_uid parameter must correspond to a business that is a member of the directory associated with the directory token.

Package Options

Use one of the following available packages: platinum20, business20.

Package names are managed in the database and may vary by directory. To obtain the complete list of available package names for your directory, please contact the support team.

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

The business UID (alphanumeric string like '88pzdbz1hmkdoel4'), not the numeric database ID. The business must be a member of the directory associated with the directory token.

Query Params
string

The updated package you assign to the specific business, for more details and available options please contact your account manager

external_subscription_params
array of strings

Billing params. Can send multiple parameter with a different key/value

external_subscription_params
string

Tags per account. Will be displayed in the Partner Dashboard. Separate with a comma

string

The Number Of SMS Credit For Add To Account

string

The Number Of SMS For Deletion From The Account

Headers
string
required

HTTP Token authentication. Format: Token token="{DIRECTORY_TOKEN}". The token must have directory scope.

Responses

Updated 2 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago