Get Recurring Application Charge

GET 
/openapi/2022-01/recurring_application_charges/:charge_id

Retrieve a specific recurring application charge by its ID.

Request

Path Parameters

charge_id stringrequired

Responses

200

200

application/json

Schema

Schema

recurring_application_charges object
idstring
Example: 372269669345671159
application_idstring
Example: s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0
namestring
Example: test
pricestring
Example: 100
capped_amountstring
Example: 10
termsstring
Example: terms
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/372269669345671159/recurring/confirm?signature=25e6433350d9dbb320bee53dd65b76db
statusstring
Example: pending
trial_daysinteger
Default value: 0
Example: 0
activated_on
trial_ends_on
billing_on
cancelled_on
cancel_sub_on
testboolean
Default value: true
Example: false
created_atstring
Example: 2024-04-23T06:26:46Z
updated_atstring
Example: 2024-04-23T06:26:46Z

Example

{
  "recurring_application_charges": {
    "id": "372269669345671159",
    "application_id": "s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0",
    "name": "test",
    "price": "100",
    "capped_amount": "10",
    "terms": "terms",
    "return_url": "https://shoplazza.com",
    "confirmation_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0/372269669345671159/recurring/confirm?signature=25e6433350d9dbb320bee53dd65b76db",
    "status": "pending",
    "trial_days": 0,
    "activated_on": {},
    "trial_ends_on": {},
    "billing_on": {},
    "cancelled_on": {},
    "cancel_sub_on": {},
    "test": false,
    "created_at": "2024-04-23T06:26:46Z",
    "updated_at": "2024-04-23T06:26:46Z"
  }
}

Result

{
    "recurring_application_charges": {
        "id": "372269669345671159",
        "application_id": "s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0",
        "name": "test",
        "price": "100",
        "capped_amount": "10",
        "terms": "terms",
        "return_url": "https://shoplazza.com",
        "confirmation_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/s1deCNrkHePwO3HDDZb_zfWJAge07nzNckPyfM_Hvp0/372269669345671159/recurring/confirm?signature=25e6433350d9dbb320bee53dd65b76db",
        "status": "pending",
        "trial_days": 0,
        "activated_on": null,
        "trial_ends_on": null,
        "billing_on": null,
        "cancelled_on": null,
        "cancel_sub_on": null,
        "test": false,
        "created_at": "2024-04-23T06:26:46Z",
        "updated_at": "2024-04-23T06:26:46Z"
    }
}