get
https://{subdomain}.myshoplaza.com/openapi/2025-06/recurring_application_charges//usage_charge
Retrieve all usage charges associated with a specific recurring application charge.
The Get Usage Charge List retrieve all usage charges associated with a specific recurring application charge.
This API is especially useful for:
- Monitoring app usage charges for billing purposes
- Reconciling application usage with customer invoices
Request Parameters
Public Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
charge_id | string | Yes | The recurring charge ID | "charge_123456789" |
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
cursor | string | No | Pagination cursor | "eyJpZCI6IjEyMzQ1Njc4OTAifQ==" |
per_page | int32 | No | Results per page (default: 20, max: 100) | 50 |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | API response status code |
message | string | "Usage charges retrieved" | Response message |
data.usage_charges | array[object] | - | Array of usage charge records |
data.usage_charges.id | string | "usage_123456" | Unique usage charge ID |
data.usage_charges.price | string | "10.00" | Charge amount |
data.usage_charges.description | string | "API call usage" | Charge description |
data.usage_charges.balance_used | string | "50.00" | Amount used from balance |
data.usage_charges.balance_remaining | string | "150.00" | Remaining balance |
data.usage_charges.created_at | string | "2025-01-15T10:30:00Z" | Charge creation timestamp |
data.cursor | string | "next_page_token" | Pagination cursor |
data.has_more | boolean | true | More records available |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |