v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Read all billing attempts

get/2023-10/billingAttempt

Query parameters

pageNointeger

The page number to fetch in a paginated response.

pageSizeinteger

The number of records to return per page.

createdAtStartEpochstring

Start of the time range (in epoch) for filtering billing attempts based on their createdAt date

createdAtEndEpochstring

End of the time range (in epoch) for filtering billing attempt based on their createdAt date.

Response

successboolean

Indicates whether the request was processed successfully.

messagestring

A message describing the result of the request.

codestring

The response code indicating the outcome of the request.

Example response

{
  "success": true,
  "message": "Billing attempts fetched successfully",
  "data": [
    {
      "shopifyId": 64878870682,
      "errorCode": "PAYMENT_METHOD_INCOMPATIBLE_WITH_GATEWAY_CONFIG",
      "errorMessage": "Gateway test mode error",
      "orderId": 223412949,
      "idempotencyKey": "13446742170-d4VWO-r2",
      "subscriptionShopifyId": 13446742170,
      "createdAt": "2026-07-01T21:38:27.000Z",
      "status": "FAILED"
    }
  ],
  "code": "SUCCESS",
  "pageInfo": {
    "hasNextPage": true
  }
}