POST/api/v2/users/{userId}/tier

Set user tier and queue the first subscription fee for scheduled fee charging

Authentication

Send your API key in the x-api-key header on every request.

Request parameters
Field	Type	Required	Description
userId (path)	unknown	Yes	User ID

application/json

Request body fields
Field	Type	Required	Description
TierId	unknown	No
TierCycle	string	No

200 — OK

Response 200 fields
Field	Type	Required
Success	boolean	No
UserId	unknown	No
TierId	unknown	No
TierName	string	No
TierLevel	string	No
OrderId	string	No
TotalCost	unknown	No
Currency	string	No
Status	string	No
PurchasedAt	string (date-time)	No
ActivatedAt	string (date-time)	No
ExpiresAt	string (date-time)	No
UpgradeDetails	TierUpgradeDetails	No
PaymentDetails	PaymentDetails	No
NewBenefits	TierBenefits	No
ErrorCode	string	No
ErrorMessage	string	No
Message	string	No
Audit	TierPurchaseAudit	No
PurchaseId	string (uuid)	No
PurchaseExpiresAt	string (date-time)	No
StripePayment	object	No

400 — Bad Request

Response 400 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

401 — Unauthorized

Response 401 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

404 — Not Found

Response 404 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

500 — Internal Server Error

Response 500 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

curl -X POST "https://{base_url}/api/v2/users/{userId}/tier" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

This page is generated from the live OpenAPI specification and always matches the current API.