curl --request GET \
--url https://api.gigstack.io/v2/invoices/income/batch/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gigstack.io/v2/invoices/income/batch/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gigstack.io/v2/invoices/income/batch/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "ibatch_5d41402abc4b2a76b9719d911017c592",
"object": "invoice_batch",
"type": "income",
"livemode": true,
"status": "processing",
"result": null,
"total": 250,
"accepted": 248,
"rejected": [
{
"index": 17,
"idempotency_key": "order-2026-09-000140",
"error": {
"code": "invalid_body",
"message": "client_id: Unexpected field"
}
},
{
"index": 42,
"idempotency_key": "order-2026-09-000123",
"error": {
"code": "duplicate_idempotency_key",
"message": "idempotency_key is already used by item 0"
}
}
],
"counts": {
"queued": 131,
"stamped": 115,
"failed": 1,
"duplicate": 1,
"needs_review": 0
},
"created_at": 1790780400000,
"completed_at": null
},
"timestamp": 1790781000000
}Get an income invoice batch
Returns the batch: the items rejected up front, and the progress of the accepted ones in counts. Poll it
until status is completed, then read result, not status, to know how it went: completed
(everything issued), partially_completed (some items have no invoice) or failed (none issued).
For each invoiceās outcome, page through GET /invoices/income/batch/{id}/items.
A batch of another team, or of the other mode (a live batch read with a test key), answers 404.
Under gigstack Connect, send the same team the batch was created with.
curl --request GET \
--url https://api.gigstack.io/v2/invoices/income/batch/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gigstack.io/v2/invoices/income/batch/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gigstack.io/v2/invoices/income/batch/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "ibatch_5d41402abc4b2a76b9719d911017c592",
"object": "invoice_batch",
"type": "income",
"livemode": true,
"status": "processing",
"result": null,
"total": 250,
"accepted": 248,
"rejected": [
{
"index": 17,
"idempotency_key": "order-2026-09-000140",
"error": {
"code": "invalid_body",
"message": "client_id: Unexpected field"
}
},
{
"index": 42,
"idempotency_key": "order-2026-09-000123",
"error": {
"code": "duplicate_idempotency_key",
"message": "idempotency_key is already used by item 0"
}
}
],
"counts": {
"queued": 131,
"stamped": 115,
"failed": 1,
"duplicate": 1,
"needs_review": 0
},
"created_at": 1790780400000,
"completed_at": null
},
"timestamp": 1790781000000
}Authorizations
Authentication Method: HTTP Bearer token.
The runtime requires the literal Bearer prefix ā a bare token in the
Authorization header is rejected with 401 unauthorized.
Header Format: Authorization: Bearer YOUR_API_KEY
Your API key is a JWT. Live keys operate on live data (livemode: true);
test keys operate on isolated test data (livemode: false).
Get your key at: app.gigstack.pro/settings?tab=api
Errors: credential failures are answered by the authentication layer with a raw
{ "message": ⦠} body, not the standardized envelope ā 401 for a missing, malformed or
expired token, 403 for a revoked key or a plan without API access. See the Unauthorized
and AuthForbidden responses.
Query Parameters
gigstack Connect: Target team ID for multi-team access.
Requires gigstack Connect enabled on your team and shared billing account.
Also requires the multipleIssuerAccounts feature on your plan. Requests targeting a
team other than the one your API key belongs to return 403 without it.
Only API keys can use it: an OAuth access token sent with another team's id is rejected with
403 Team mismatch with OAuth token.
Optional ā omit it entirely unless you are acting on another team. It deliberately
carries no example value so generated snippets do not emit ?team=undefined; when the
parameter is absent, the team is derived from your API key.
Example: ?team=team_xyz789
Response
The batch.
Standardized success envelope emitted by sendSuccessResponse.