PATCH
/
vendors
/
{vendor_id}
curl --request PATCH \
  --url https://api.charp.ai/vendors/{vendor_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "plan": "Free",
  "credits": 123
}'
{
  "vendor_id": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "plan": "Free",
  "credits": 123,
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using OAuth2 access token

Path Parameters

​
vendor_id
string
required

Unique identifier of the vendor

Body

application/json
Vendor plan details to update
​
plan
enum<string>
required

Updated subscription plan of the vendor

Available options:
Free,
Standard,
Enterprise
​
credits
integer
required

Updated available credits for the vendor

Response

200
application/json
Vendor plan details updated successfully
​
vendor_id
string
required

Unique identifier of the vendor

​
name
string
required

Name of the vendor

​
email
string
required

Email of the vendor

​
plan
enum<string>
required

Subscription plan of the vendor

Available options:
Free,
Standard,
Enterprise
​
credits
integer
required

Available credits for the vendor

​
status
enum<string>
required

Status of the vendor account

Available options:
active,
inactive,
suspended
​
created_at
string

Timestamp when the vendor was created