Get Recurring Application Charge List

GET 
/openapi/2022-01/recurring_application_charges

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

Request

Query Parameters

per_page int32

Limit per page

since_id string

The query results are in reverse order, and this parameter limits the results after the specified ID.

charges_status string

Filter charges by charges status, separated by comma, for example: pending,accepted,declined,active,expired,frozen,cancelled,paid_failed,paying

Responses

200

200

application/json

Schema

Schema

countinteger
Default value: 0
Example: 1
recurring_application_charges object[]
Array [
idstring
Example: 372269508187928567
application_idstring
Example: s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0
namestring
Example: test
pricestring
Example: 100
capped_amountstring
Example: 10
termsstring
Example: tempor consectetur anim aute
return_urlstring
Example: https://shoplazza.com
confirmation_urlstring
Example: https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0/372269508187928567/recurring/confirm?signature=a0113ba925f813b6535a36976ba68086
statusstring
Example: active
trial_daysinteger
Default value: 0
Example: 0
activated_onstring
Example: 2024-04-23T00:00:00Z
trial_ends_on
billing_onstring
Example: 2024-05-23T00:00:00Z
cancelled_on
cancel_sub_on
testboolean
Default value: true
Example: false
created_atstring
Example: 2024-04-23T06:26:07Z
updated_atstring
Example: 2024-04-23T06:26:16Z
]

Example

{
  "count": 1,
  "recurring_application_charges": [
    {
      "id": "372269508187928567",
      "application_id": "s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0",
      "name": "test",
      "price": "100",
      "capped_amount": "10",
      "terms": "tempor consectetur anim aute",
      "return_url": "https://shoplazza.com",
      "confirmation_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0/372269508187928567/recurring/confirm?signature=a0113ba925f813b6535a36976ba68086",
      "status": "active",
      "trial_days": 0,
      "activated_on": "2024-04-23T00:00:00Z",
      "trial_ends_on": {},
      "billing_on": "2024-05-23T00:00:00Z",
      "cancelled_on": {},
      "cancel_sub_on": {},
      "test": false,
      "created_at": "2024-04-23T06:26:07Z",
      "updated_at": "2024-04-23T06:26:16Z"
    }
  ]
}

Result

{
    "count": 1,
    "recurring_application_charges": [
        {
            "id": "372269508187928567",
            "application_id": "s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0",
            "name": "test",
            "price": "100",
            "capped_amount": "10",
            "terms": "tempor consectetur anim aute",
            "return_url": "https://shoplazza.com",
            "confirmation_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0/372269508187928567/recurring/confirm?signature=a0113ba925f813b6535a36976ba68086",
            "status": "active",
            "trial_days": 0,
            "activated_on": "2024-04-23T00:00:00Z",
            "trial_ends_on": null,
            "billing_on": "2024-05-23T00:00:00Z",
            "cancelled_on": null,
            "cancel_sub_on": null,
            "test": false,
            "created_at": "2024-04-23T06:26:07Z",
            "updated_at": "2024-04-23T06:26:16Z"
        }
    ]
}