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

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Description	Example
`cursor`	string	No	Cursor for pagination	`next_page_cursor`
`page_size`	int32	No	Page size for the number of charges to retrieve. Default to 8	`10`
`charges_status`	string	No	Filter charges by status	`active`

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Example	Description
`code`	string	`"success"`	Status indicator
`message`	string	`"Inventory levels retrieved"`	Result description
`data.application_charges`	array of objects	`[ {...}, {...} ]`	List of application charges
`data.cursor`	string	`next_page_cursor`	Cursor for next page
`data.has_more`	boolean	`true`	Whether there are more pages available

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

200OK