Account
Here is an example API documentation for the endpoint used for checking account's package status.
REQUEST
Endpoint
HTTP Method
Description
This endpoint is used to check the status of a package account using the provided API key. The request should be made using the GET method and include the API key as a parameter.
Parameter(s)
apikey
(string, required): The API key provided to the user.
Example Request
Example Response
Success Response
If the HTTP response is 200 (success response), it will generate the following response:
Description on successful response
status
: Response Status: The value is "success" if the request is successful.token
: Account token sent in the response.Packages
: Name of the active account package.Quota
: Amount of available quota in the account package.Usage
: Current usage amount.ExpiredDate
: Date and time when the package will expire.timeResponse
: Date and time when the response was sent.
Failed Response
If the HTTP response is 400 or 401 (failed response), it will generate the following response:
Description on failed response:
status
: Response Status: The value is "failed" if the request fails.timeResponse
: Date and time when the response was sent.
Notes
Please make sure to replace
apikey
with a valid API key.Check the value of the HTTP response to determine the appropriate response.
Please note the date and time format used in the response.
Last updated