post
https://{subdomain}.myshoplaza.com/openapi/2025-06/application_charges
Create a charge for an application within Shoplazza.
The Create Application Charge API is used to create a charge for an application within Shoplazza. This API is essential for developers implementing billing functionalities for their apps, ensuring that the charges match the pricing defined in the APP package settings.
This API is especially useful for:
- Enabling app developers to implement and test billing workflows.
- Create a charge for an application with one time charge or free to install model.
Request Parameters
Public Request Parameters
Body Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
application_charge.name | string | Yes | The application charge name | Premium Plan |
application_charge.price | string | Yes | The amount of the charge, must match with the APP package setting amount | 19.99 |
application_charge.return_url | string | Yes | Redirect URL after payment | https://example.com/return |
application_charge.test | boolean | No | Whether to test the charge, default to false | true |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status indicator |
message | string | "Inventory levels retrieved" | Result description |
data.application_charge | objects | {...} | application charges= |
Application Charge Object Structure
| Parameter | Type | Example | Description |
|---|---|---|---|
id | string | chg_123456 | Unique identifier for the charge |
name | string | Premium Plan | Name of the charge |
price | string | 19.99 | Price of the charge |
confirm_url | string | https://example.com/confirm | URL to confirm the charge |
return_url | string | https://example.com/return | URL to return after confirmation |
status | string | active | Status of the charge |
test | boolean | false | Whether this is a test charge |
created_at | string | 2023-06-01T00:00:00Z | Creation time (ISO 8601 format) |
updated_at | string | 2023-06-01T00:00:00Z | Last modified time (ISO 8601 format) |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |