List Recurring Application Charge

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

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 Description

Public Response Fields

📘
Public Response Parameters

Success Response

Field	Type	Example	Description
`code`	`string`	`"success"`	Status code of the response
`message`	`string`		Descriptive message of the response
`data.recurring_application_charges`	array of objects	`[ {...}, {...} ]`	List of recurring charges
`data.cursor`	string	`next_page_cursor`	Cursor for next page
`data.has_more`	boolean	`true`	Whether there are more pages available

Recurring Charge Object Structure

Parameter	Type	Example	Description
`id`	string	`rch_123456`	Unique identifier for the recurring charge
`application_id`	string	`app_123456`	ID of the associated application
`name`	string	`Premium Plan`	Name of the recurring charge
`price`	string	`19.99`	Price of the charge
`capped_amount`	string	`100.00`	Maximum amount that can be charged
`terms`	string	`Monthly subscription`	Terms of the charge
`return_url`	string	`https://example.com/return`	URL to return after confirmation
`confirmation_url`	string	`https://example.com/confirm`	URL to confirm the charge
`status`	string	`active`	Status of the charge
`trial_days`	int32	`14`	Number of trial days
`activated_on`	string	`2023-06-01T00:00:00Z`	Date when charge was activated (ISO 8601 format)
`trial_ends_on`	string	`2023-06-15T00:00:00Z`	Date when trial ends (ISO 8601 format)
`billing_on`	string	`2023-06-16T00:00:00Z`	Date when billing occurs (ISO 8601 format)
`cancelled_on`	string	`2023-06-30T00:00:00Z`	Date when charge was cancelled (ISO 8601 format)
`cancel_sub_on`	string	`2023-06-30T00:00:00Z`	Date when subscription was cancelled (ISO 8601 format)
`test`	boolean	`false`	Whether this is a test charge
`created_at`	string	`2023-05-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