get https://{shopdomain}.myshoplaza.com/openapi/2022-01/application_charges
The Get Application Charge List API retrieves a paginated list of application charges associated with the current store. This allows developers to view and filter application charges based on specific criteria.
This API is especially useful for:
- Retrieving all application charges for auditing and analysis.
- Filtering charges based on their status or creation time.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
per_page | int32 | No | Limit per page. Defaults to 20. Maximum value is 250. | 20 |
since_id | string | No | Restrict results to after the specified ID. | 372212374292312759 |
charges_status | string | No | Filter charges by their statuses, separated by commas (e.g., pending, accepted, declined, etc.). | pending,accepted,declined,active,expired<br>frozen,cancelled,paid_failed,paying |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
count | int | Total number of application charges returned. | 8 |
application_charges | array | A list of application charges. | |
application_charges[].id | string | The unique ID of the application charge. | 372212374292312759 |
application_charges[].name | string | The name of recurring application charge. | test |
application_charges[].price | string | The price of the application charge. | 10.0 |
application_charges[].confirm_url | string | The confirmation URL for the application charge. | https://test-shoplazza.stg.myshoplaza.com |
application_charges[].return_url | string | The redirect URL after payment. | https://shoplazza.com |
application_charges[].status | string | The current status of the application charge. | active |
application_charges[].test | boolean | Whether this is a test charge. | false |
application_charges[].created_at | string | The creation timestamp of the application charge. | 2024-04-23T02:39:05Z |
application_charges[].updated_at | string | The last updated timestamp of the application charge. | 2024-04-23T02:39:19Z |
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 |
|---|---|---|---|
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 |