The Get Recurring Application Charge List API is used to retrieve a paginated list of recurring application charges created for the current store. The query can be filtered by charge status and other parameters to narrow down the results.

This API is especially useful for:

Tracking and managing recurring application charges for a store.
Filtering charges based on their status, such as pending, active, or cancelled.
Monitoring the billing and payment lifecycle of recurring charges.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Query Parameters

Name	Type	Required	Description	Example
`per_page`	int32	No	Limit per page. Defaults to 20.	`10`
`since_id`	string	No	The query results are in reverse order, and this parameter limits the results after the specified ID.	`12345`
`charges_status`	string	No	Filter charges by charge status, separated by commas. Supported statuses: `pending`, `accepted`, `declined`, `active`, `expired`, `frozen`, `cancelled`, `paid_failed`, `paying`.	`pending,active`

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Success Response

Field	Type	Description	Example
`count`	int	Total number of charges.	`1`
`recurring_application_charges`	array	List of recurring application charges.	See example below.
`id`	string	Unique identifier of the charge.	`"372269508187298657"`
`application_id`	string	Application ID associated with the charge.	`"sldcNxrKHePw03HDC"`
`name`	string	Name of the charge.	`"test"`
`price`	string	Price of the recurring charge.	`"100"`
`capped_amount`	string	Maximum amount that can be charged.	`"10"`
`terms`	string	Terms of the usage-based billing.	`"terms"`
`return_url`	string	Redirect URL after payment.	`"https://shoplazza.com"`
`confirmation_url`	string	Confirmation URL for the charge.	`"https://test-shoplazza.com"`
`status`	string	Current status of the charge (`active`, `cancelled`, etc.).	`"active"`
`trial_days`	int	Number of trial days for the charge.	`0`
`activated_on`	string	Date when the charge was activated.	`"2024-04-23T00:00:00Z"`
`billing_on`	string	Next billing date for the charge.	`"2024-05-23T00:00:00Z"`
`cancelled_on`	string	Date when the charge was cancelled, if applicable.	`null`
`cancel_sub_on`	string	Date when the subscription will be cancelled, if applicable.	`null`
`test`	boolean	Indicates if this is a test charge.	`false`
`created_at`	string	Date and time when the charge was created.	`"2024-04-23T06:26:16Z"`
`updated_at`	string	Date and time when the charge was last updated.	`"2024-04-23T06:26:16Z"`

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`

API Structure Overview