List recurring application charges

GET 
/openapi/2026-07/recurring_application_charges

Retrieve a paginated list of recurring application charges created for the current store.

Request

Query Parameters

cursor string

Cursor for pagination

page_size int32

Number of records per page. Defaults to 8

charges_status string
Filter by charge status:
• pending: pending
• accepted: accepted
• declined: declined
• active: active
• expired: expired
• frozen: frozen
• cancelled: cancelled
• paid_failed: payment failed
• paying: paying

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

recurring_application_charges object[]

List of recurring application charges

Array [

idstring

Recurring application charge ID

application_idstring

Application ID

namestring

Charge name shown to the merchant

pricestring

Recurring charge amount

capped_amountstring

Capped amount for usage-based billing

termsstring

Terms and conditions text shown to the merchant for usage-based billing

return_urlstring

URL the merchant returns to after confirming the charge

confirmation_urlstring

URL the merchant is redirected to in order to confirm the charge

statusstring

Current status of the recurring application charge

trial_daysint32

Number of trial days offered for the subscription

activated_onstring

Date when the subscription was activated

trial_ends_onstring

Date when the trial period ends

billing_onstring

Next billing date

cancelled_onstring

Charge cancellation date

cancel_sub_onstring

Subscription cancellation date

testboolean

Whether this is a test charge

created_atstring

Creation time, in ISO-8601 format

updated_atstring

Last update time, in ISO-8601 format

charge_interval_daysint32

Charge interval in days

]

cursorstring

Cursor for pagination

has_moreboolean

Whether there are more records

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "recurring_application_charges": [
      {
        "id": "string",
        "application_id": "string",
        "name": "string",
        "price": "string",
        "capped_amount": "string",
        "terms": "string",
        "return_url": "string",
        "confirmation_url": "string",
        "status": "string",
        "trial_days": 0,
        "activated_on": "string",
        "trial_ends_on": "string",
        "billing_on": "string",
        "cancelled_on": "string",
        "cancel_sub_on": "string",
        "test": true,
        "created_at": "string",
        "updated_at": "string",
        "charge_interval_days": 0
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}