Raw schema
{
"type": "object",
"properties": {
"customer_id": {
"description": "Filter by customer id.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"address_id": {
"description": "Filter by address id.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"status": {
"description": "Filter by charge status: success | queued | error | refunded | partially_refunded | skipped | pending_manual_payment | pending.",
"type": "string",
"enum": [
"success",
"queued",
"error",
"refunded",
"partially_refunded",
"skipped",
"pending_manual_payment",
"pending"
]
},
"ids": {
"description": "Comma-separated list of charge ids to fetch.",
"type": "string"
},
"purchase_item_id": {
"description": "Filter to charges containing this purchase item (subscription/onetime line item) id.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"scheduled_at": {
"description": "Filter to charges scheduled on this date (ISO 8601).",
"type": "string"
},
"scheduled_at_min": {
"description": "Filter to charges scheduled on/after this date (ISO 8601).",
"type": "string"
},
"scheduled_at_max": {
"description": "Filter to charges scheduled on/before this date (ISO 8601).",
"type": "string"
},
"created_at_min": {
"description": "Filter to charges created on/after this date (ISO 8601).",
"type": "string"
},
"created_at_max": {
"description": "Filter to charges created on/before this date (ISO 8601).",
"type": "string"
},
"updated_at_min": {
"description": "Filter to charges updated on/after this date (ISO 8601).",
"type": "string"
},
"updated_at_max": {
"description": "Filter to charges updated on/before this date (ISO 8601).",
"type": "string"
},
"sort_by": {
"description": "Sort order: id-asc | id-desc | updated_at-asc | updated_at-desc | scheduled_at-asc | scheduled_at-desc.",
"type": "string",
"enum": [
"id-asc",
"id-desc",
"updated_at-asc",
"updated_at-desc",
"scheduled_at-asc",
"scheduled_at-desc"
]
},
"limit": {
"description": "Max results per page (1-250, default 50).",
"type": "integer",
"minimum": 1,
"maximum": 250
},
"cursor": {
"description": "Pagination cursor (next_cursor / previous_cursor from a prior response). Use it ALONE with `limit` โ omit all other filters on cursor requests.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}