--- updatedAt: 2026-06-30T16:05:21.000Z agentTools: projectIndex: https://docs.pelcro.com/llms.txt --- # List charges Retrieve a paginated list of charges. ## Overview Retrieve a paginated list of all charges. Use filters to narrow results by customer, status, or date range. **Example:** List all successful charges from the last month for revenue reporting. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "core-api", "version": "1.88" }, "servers": [ { "url": "https://www.pelcro.com/api/v1/core" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "Authorization", "x-bearer-format": "bearer" }, "sec1": { "type": "apiKey", "in": "query", "name": "site_id" } } }, "security": [ { "sec0": [], "sec1": [] } ], "paths": { "/charges": { "get": { "summary": "List charges", "description": "Retrieve a paginated list of charges.", "operationId": "api-core-list-charges", "parameters": [ { "name": "site_id", "in": "query", "description": "The unique identifier of the site associated with your account.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects you want returned per result set. For instance, if you set limit=10, the API will return a maximum of 10 objects in the response. (max: 100)", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "page", "in": "query", "description": "The specific page of the result set you want to retrieve, typically used in conjunction with limit. For example, if you set page=2 and limit=10, the API will return the second page of results, containing a maximum of 10 objects starting from the 11th object.", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "default": "Bearer eyJ***" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t\"data\": [\n\t\t{\n\t\t\t\"id\": 618,\n\t\t\t\"invoice_id\": 2937,\n\t\t\t\"amount\": 50,\n\t\t\t\"amount_refunded\": 0,\n\t\t\t\"description\": null,\n\t\t\t\"paid\": true,\n\t\t\t\"refunded\": false,\n\t\t\t\"status\": \"succeeded\",\n\t\t\t\"statement_descriptor\": null,\n\t\t\t\"offline\": true,\n \"reference\": \"charge reference\",\n\t\t\t\"payment_category\": null,\n\t\t\t\"offline_entered_by\": 2,\n\t\t\t\"metadata\": [],\n\t\t\t\"created_at\": 1660441778,\n\t\t\t\"updated_at\": 1660441778,\n\t\t\t\"deleted_at\": null\n\t\t},\n\t\t{\n\t\t\t\"id\": 617,\n\t\t\t\"invoice_id\": 2959,\n\t\t\t\"amount\": 2600,\n\t\t\t\"amount_refunded\": 0,\n\t\t\t\"description\": \"Subscription update\",\n\t\t\t\"paid\": false,\n\t\t\t\"refunded\": false,\n\t\t\t\"status\": \"failed\",\n\t\t\t\"statement_descriptor\": \"CAD\",\n\t\t\t\"offline\": false,\n \"reference\": \"charge reference\",\n\t\t\t\"payment_category\": 1,\n\t\t\t\"offline_entered_by\": null,\n\t\t\t\"metadata\": [],\n\t\t\t\"created_at\": 1655064261,\n\t\t\t\"updated_at\": 1660399636,\n\t\t\t\"deleted_at\": null\n\t\t},\n\t\t{\n\t\t\t\"id\": 616,\n\t\t\t\"invoice_id\": 2944,\n\t\t\t\"amount\": 800,\n\t\t\t\"amount_refunded\": 0,\n\t\t\t\"description\": \"Subscription update\",\n\t\t\t\"paid\": false,\n\t\t\t\"refunded\": false,\n\t\t\t\"status\": \"failed\",\n\t\t\t\"statement_descriptor\": \"CAD\",\n\t\t\t\"offline\": false,\n \"reference\": \"charge reference\",\n\t\t\t\"payment_category\": 1,\n\t\t\t\"offline_entered_by\": null,\n\t\t\t\"metadata\": [],\n\t\t\t\"created_at\": 1660395990,\n\t\t\t\"updated_at\": 1660399580,\n\t\t\t\"deleted_at\": null\n\t\t},\n\t\t{\n\t\t\t\"id\": 615,\n\t\t\t\"invoice_id\": 2937,\n\t\t\t\"amount\": 50,\n\t\t\t\"amount_refunded\": 0,\n\t\t\t\"description\": null,\n\t\t\t\"paid\": true,\n\t\t\t\"refunded\": false,\n\t\t\t\"status\": \"succeeded\",\n\t\t\t\"statement_descriptor\": null,\n\t\t\t\"offline\": true,\n \"reference\": \"charge reference\",\n\t\t\t\"payment_category\": null,\n\t\t\t\"offline_entered_by\": 2,\n\t\t\t\"metadata\": [],\n\t\t\t\"created_at\": 1660357832,\n\t\t\t\"updated_at\": 1660357832,\n\t\t\t\"deleted_at\": null\n\t\t},\n\t\t{\n\t\t\t\"id\": 614,\n\t\t\t\"invoice_id\": 2937,\n\t\t\t\"amount\": 50,\n\t\t\t\"amount_refunded\": 0,\n\t\t\t\"description\": null,\n\t\t\t\"paid\": true,\n\t\t\t\"refunded\": false,\n\t\t\t\"status\": \"succeeded\",\n\t\t\t\"statement_descriptor\": null,\n\t\t\t\"offline\": true,\n \"reference\": \"charge reference\",\n\t\t\t\"payment_category\": null,\n\t\t\t\"offline_entered_by\": 2,\n\t\t\t\"metadata\": [],\n\t\t\t\"created_at\": 1660357794,\n\t\t\t\"updated_at\": 1660357794,\n\t\t\t\"deleted_at\": null\n\t\t},\n\t\t{\n\t\t\t\"id\": 613,\n\t\t\t\"invoice_id\": null,\n\t\t\t\"amount\": 50,\n\t\t\t\"amount_refunded\": 0,\n\t\t\t\"description\": null,\n\t\t\t\"paid\": true,\n\t\t\t\"refunded\": false,\n\t\t\t\"status\": \"succeeded\",\n\t\t\t\"statement_descriptor\": null,\n\t\t\t\"offline\": true,\n \"reference\": \"charge reference\",\n\t\t\t\"payment_category\": null,\n\t\t\t\"offline_entered_by\": 2,\n\t\t\t\"metadata\": [],\n\t\t\t\"created_at\": 1660357724,\n\t\t\t\"updated_at\": 1660357724,\n\t\t\t\"deleted_at\": null\n\t\t},\n\t\t{\n\t\t\t\"id\": 605,\n\t\t\t\"invoice_id\": 2899,\n\t\t\t\"amount\": 100,\n\t\t\t\"amount_refunded\": 0,\n\t\t\t\"description\": \"Subscription creation\",\n\t\t\t\"paid\": true,\n\t\t\t\"refunded\": false,\n\t\t\t\"status\": \"credited\",\n\t\t\t\"statement_descriptor\": null,\n\t\t\t\"offline\": false,\n \"reference\": \"charge reference\",\n\t\t\t\"payment_category\": 1,\n\t\t\t\"offline_entered_by\": null,\n\t\t\t\"metadata\": {\n\t\t\t\t\"refunded_on_customer_balance\": \"100\",\n\t\t\t\t\"credit_note_id\": \"23\"\n\t\t\t},\n\t\t\t\"created_at\": 1660344091,\n\t\t\t\"updated_at\": 1660344154,\n\t\t\t\"deleted_at\": null\n\t\t},\n\t\t{\n\t\t\t\"id\": 604,\n\t\t\t\"invoice_id\": 2897,\n\t\t\t\"amount\": 100,\n\t\t\t\"amount_refunded\": 0,\n\t\t\t\"description\": \"Subscription creation\",\n\t\t\t\"paid\": true,\n\t\t\t\"refunded\": false,\n\t\t\t\"status\": \"succeeded\",\n\t\t\t\"statement_descriptor\": null,\n\t\t\t\"offline\": false,\n \"reference\": \"charge reference\",\n\t\t\t\"payment_category\": 1,\n\t\t\t\"offline_entered_by\": null,\n\t\t\t\"metadata\": [],\n\t\t\t\"created_at\": 1660344021,\n\t\t\t\"updated_at\": 1660344024,\n\t\t\t\"deleted_at\": null\n\t\t},\n\t\t{\n\t\t\t\"id\": 603,\n\t\t\t\"invoice_id\": 2880,\n\t\t\t\"amount\": 100,\n\t\t\t\"amount_refunded\": 100,\n\t\t\t\"description\": \"Subscription creation\",\n\t\t\t\"paid\": true,\n\t\t\t\"refunded\": true,\n\t\t\t\"status\": \"refunded\",\n\t\t\t\"statement_descriptor\": null,\n\t\t\t\"offline\": false,\n \"reference\": \"charge reference\",\n\t\t\t\"payment_category\": 1,\n\t\t\t\"offline_entered_by\": null,\n\t\t\t\"metadata\": [],\n\t\t\t\"created_at\": 1660343557,\n\t\t\t\"updated_at\": 1660343586,\n\t\t\t\"deleted_at\": null\n\t\t},\n\t\t{\n\t\t\t\"id\": 602,\n\t\t\t\"invoice_id\": 2878,\n\t\t\t\"amount\": 1200,\n\t\t\t\"amount_refunded\": 0,\n\t\t\t\"description\": \"Subscription update\",\n\t\t\t\"paid\": false,\n\t\t\t\"refunded\": false,\n\t\t\t\"status\": \"failed\",\n\t\t\t\"statement_descriptor\": \"CAD\",\n\t\t\t\"offline\": false,\n \"reference\": \"charge reference\",\n\t\t\t\"payment_category\": 1,\n\t\t\t\"offline_entered_by\": null,\n\t\t\t\"metadata\": [],\n\t\t\t\"created_at\": 1655149815,\n\t\t\t\"updated_at\": 1660340159,\n\t\t\t\"deleted_at\": null\n\t\t}\n\t],\n\t\"links\": {\n\t\t\"first\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=1\",\n\t\t\"last\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=16\",\n\t\t\"prev\": null,\n\t\t\"next\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=2\"\n\t},\n\t\"meta\": {\n\t\t\"current_page\": 1,\n\t\t\"from\": 1,\n\t\t\"last_page\": 16,\n\t\t\"links\": [\n\t\t\t{\n\t\t\t\t\"url\": null,\n\t\t\t\t\"label\": \"« Previous\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=1\",\n\t\t\t\t\"label\": \"1\",\n\t\t\t\t\"active\": true\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=2\",\n\t\t\t\t\"label\": \"2\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=3\",\n\t\t\t\t\"label\": \"3\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=4\",\n\t\t\t\t\"label\": \"4\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=5\",\n\t\t\t\t\"label\": \"5\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=6\",\n\t\t\t\t\"label\": \"6\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=7\",\n\t\t\t\t\"label\": \"7\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=8\",\n\t\t\t\t\"label\": \"8\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=9\",\n\t\t\t\t\"label\": \"9\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=10\",\n\t\t\t\t\"label\": \"10\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": null,\n\t\t\t\t\"label\": \"...\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=15\",\n\t\t\t\t\"label\": \"15\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=16\",\n\t\t\t\t\"label\": \"16\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges?page=2\",\n\t\t\t\t\"label\": \"Next »\",\n\t\t\t\t\"active\": false\n\t\t\t}\n\t\t],\n\t\t\"path\": \"https:\\/\\/www.pelcro.com\\/api\\/v1\\/core\\/charges\",\n\t\t\"per_page\": 10,\n\t\t\"to\": 10,\n\t\t\"total\": 154\n\t}\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 618, "default": 0 }, "invoice_id": { "type": "integer", "example": 2937, "default": 0 }, "amount": { "type": "integer", "example": 50, "default": 0 }, "amount_refunded": { "type": "integer", "example": 0, "default": 0 }, "description": {}, "paid": { "type": "boolean", "example": true, "default": true }, "refunded": { "type": "boolean", "example": false, "default": true }, "status": { "type": "string", "example": "succeeded" }, "statement_descriptor": {}, "offline": { "type": "boolean", "example": true, "default": true }, "reference": { "type": "string", "example": "charge reference" }, "payment_category": {}, "offline_entered_by": { "type": "integer", "example": 2, "default": 0 }, "metadata": { "type": "array" }, "created_at": { "type": "integer", "example": 1660441778, "default": 0, "format": "int64" }, "updated_at": { "type": "integer", "example": 1660441778, "default": 0, "format": "int64" }, "deleted_at": {} } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https://www.pelcro.com/api/v1/core/charges?page=1" }, "last": { "type": "string", "example": "https://www.pelcro.com/api/v1/core/charges?page=16" }, "prev": {}, "next": { "type": "string", "example": "https://www.pelcro.com/api/v1/core/charges?page=2" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "from": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 16, "default": 0 }, "links": { "type": "array", "items": { "type": "object", "properties": { "url": {}, "label": { "type": "string", "example": "« Previous" }, "active": { "type": "boolean", "example": false, "default": true } } } }, "path": { "type": "string", "example": "https://www.pelcro.com/api/v1/core/charges" }, "per_page": { "type": "integer", "example": 10, "default": 0 }, "to": { "type": "integer", "example": 10, "default": 0 }, "total": { "type": "integer", "example": 154, "default": 0 } } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error\": {\n \"status\": 400,\n \"message\": \"Invalid request, please try again.\"\n }\n}" } }, "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "message": { "type": "string", "example": "Invalid request, please try again." } } } } } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "examples": { "Result": { "value": { "error": "Unauthenticated." } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` # Sibling pages * [Create offline charge](https://docs.pelcro.com/reference/api-core-create-offline-charge.md) * [Get charge](https://docs.pelcro.com/reference/api-core-get-charge.md)