get
https://{shopdomain}.myshoplaza.com/openapi/2022-01/recurring_application_charges/
The Get Recurring Application Charge API is used to retrieve detailed information about a specific recurring application charge using its unique identifier (charge_id). This API helps developers verify the status, configuration, and metadata of a recurring charge associated with an application.
This API is especially useful for:
- Tracking the current status of a recurring charge (e.g.,
pending,active,cancelled). - Viewing important charge metadata such as
price,terms, andreturn_url. - Auditing the lifecycle of a recurring application charge.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
charge_id | string | required | The unique identifier of the recurring charge | 37222669345671159 |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
id | string | The unique ID of the recurring charge | 37222669345671159 |
application_id | string | The ID of the application associated with the charge | s1deCNxrHkePwO3HDZDb_zfwJAqe07nz |
name | string | The name of the recurring application charge | test |
price | string | The price of the recurring application charge | 100 |
capped_amount | string | The capped amount for usage-based billing | 10 |
terms | string | The terms and conditions of the recurring application charge | terms |
return_url | string | The URL to which the user is redirected after payment | https://shoplazza.com |
confirmation_url | string | The URL where the user can confirm the charge | https://test-shoplazza.stg.myshoplaza.com/a/confirm_url |
status | string | The current status of the charge (e.g., pending, active, cancelled) | pending |
trial_days | int32 | The number of trial days for the charge | 0 |
activated_on | string | The date when the charge was activated | null |
trial_ends_on | string | The date when the trial period ends | null |
billing_on | string | The date when billing starts | null |
cancelled_on | string | The date when the charge was cancelled | null |
cancel_sub_on | string | The date when the subscription was cancelled | null |
test | boolean | Indicates whether this is a test charge (true or false) | false |
created_at | datetime | The date when the charge was created | 2024-04-23T06:26:46Z |
updated_at | datetime | The date when the charge was last updated | 2024-04-23T06:26:46Z |
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.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "page not found" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 404 | Not Found | The charge Id is not found or empty. | "Record not found" |