The Create Usage Charge API is used to create usage-based charges for a recurring application charge within Shoplazza. This API allows app developers to bill merchants based on their additional usage exceeding the amount defined in their recurring subscription.
This API is especially useful for:
Charging merchants for usage-based services like API requests, storage, or additional features.
Monitoring and recording usage-related charges within a subscription plan.
Ensuring merchants are billed within the capped amount set during subscription.
The amount already used in the current billing cycle.
"3.00"
balance_remaining
string
The remaining balance available in the capped amount.
"7.00"
created_at
string
Timestamp when the usage charge was created.
"2024-04-23T06:40:51Z"
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "file number error"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
String
"page not found"
Indicates an error encountered during the process
Error Detail
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
404
Not Found
The charge Id is not found or empty.
"Record not found"
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
