AppsThemesAPIs and referencesFAQSupportFeedBack
API Reference
Log inSign up

Get Application Charge Detail

get https://{shopdomain}.myshoplaza.com/openapi/2022-01/application_charges/

The Get Application Charge Detail API retrieves detailed information about a specific application charge using its unique charge_id.

This API is especially useful for:

  1. Verifying the status of a specific application charge.
  2. Reviewing details such as charge name, price, and return URL.
  3. Debugging or auditing application charges.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Path Parameters

ParameterTypeRequiredDescriptionExample
charge_idstringYesThe unique ID of the application charge.372212374292312759

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Success Response

FieldTypeDescriptionExample
application_charge.idstringThe unique ID of the application charge.372212374292312759
application_charge.namestringThe name of recurring application charge.test
application_charge.pricestringThe price of the application charge.10.0
application_charge.confirm_urlstringThe confirmation URL for the application charge.https://test-shoplazza.stg.myshoplaza.com
application_charge.return_urlstringThe redirect URL after payment.https://shoplazza.com
application_charge.statusstringThe current status of the application charge.active
application_charge.testbooleanWhether this is a test charge.false
application_charge.created_atstringThe creation timestamp of the application charge.2024-04-23T02:39:05Z
application_charge.updated_atstringThe last updated timestamp of the application charge.2024-04-23T02:39:19Z

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

FieldTypeExampleDescription
errorsArray[ "file number error"]A list of errors encountered during the request processing.
FieldTypeExampleDescription
errorString "page not found"Indicates an error encountered during the process

Error Detail

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized
404Not Foundempty charge id"Record not found"

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!

Support

Shoplazza

Updates

Partner Program

Support

Shoplazza

Updates

Partner Program

Follow Us

© Shoplazza
Partner Program Agreement API Terms Terms of Service Privacy Policy Use Policy