Get Application Charge Detail

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

Look up a one-time application charge by its ID.

Request

Path Parameters

charge_id stringrequired

The application charge id

Responses

200

200

application/json

Schema

Schema

application_charge object
idstring
Example: 372212374209312759
application_idstring
Example: Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU
namestring
Example: test
pricestring
Example: 100
confirm_urlstring
Example: https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU/372212374209312759/one-time/confirm?signature=83207d1ad129d5c2ac36bd8b1b6ff8a8
return_urlstring
Example: https://shoplazza.com
statusstring
Example: active
testboolean
Default value: true
Example: false
created_atstring
Example: 2024-04-23T02:39:05Z
updated_atstring
Example: 2024-04-23T02:39:19Z

Example

{
  "application_charge": {
    "id": "372212374209312759",
    "application_id": "Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU",
    "name": "test",
    "price": "100",
    "confirm_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU/372212374209312759/one-time/confirm?signature=83207d1ad129d5c2ac36bd8b1b6ff8a8",
    "return_url": "https://shoplazza.com",
    "status": "active",
    "test": false,
    "created_at": "2024-04-23T02:39:05Z",
    "updated_at": "2024-04-23T02:39:19Z"
  }
}

Result

{
    "application_charge": {
        "id": "372212374209312759",
        "application_id": "Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU",
        "name": "test",
        "price": "100",
        "confirm_url": "https://test-shoplazza.stg.myshoplaza.com/admin/smart_apps/angora/app_store/charges/Kmby9zm_W1dlg11zyVY1XtVkG3teakrbTYPwwmE6WhU/372212374209312759/one-time/confirm?signature=83207d1ad129d5c2ac36bd8b1b6ff8a8",
        "return_url": "https://shoplazza.com",
        "status": "active",
        "test": false,
        "created_at": "2024-04-23T02:39:05Z",
        "updated_at": "2024-04-23T02:39:19Z"
    }
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Record not found"
  ]
}

Result

{
  "errors": [
    "Record not found"
  ]
}