---
updatedAt: 2026-05-05T20:25:41.000Z
agentTools:
  siteIndex: https://docs.recurly.com/llms.txt
  projectIndex: https://docs.recurly.com/recurly-commerce/llms.txt
---

# List Billing Attempts

Retrieve a list of billing attempts

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v1/billingAttempts": {
      "get": {
        "operationId": "listBillingAttempts",
        "summary": "List Billing Attempts",
        "description": "Retrieve a list of billing attempts",
        "parameters": [
          {
            "name": "page",
            "required": true,
            "in": "query",
            "description": "Page number",
            "schema": {
              "default": 1,
              "type": "number"
            }
          },
          {
            "name": "limit",
            "required": true,
            "in": "query",
            "description": "Items per page. Limit must be between 1 and 250.",
            "schema": {
              "default": 10,
              "type": "number"
            }
          },
          {
            "name": "sort",
            "required": false,
            "in": "query",
            "description": "Sort order. If not set, default is createdAt.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "desc",
            "required": false,
            "in": "query",
            "description": "Sort direction. If not set, default is ASC.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "minCreatedAt",
            "required": false,
            "in": "query",
            "description": "The min date of createdAt",
            "schema": {
              "format": "date-time",
              "default": "2023-01-01T00:00:00.000Z",
              "type": "string"
            }
          },
          {
            "name": "maxCreatedAt",
            "required": false,
            "in": "query",
            "description": "The max date of createdAt",
            "schema": {
              "format": "date-time",
              "default": "2023-01-01T00:00:00.000Z",
              "type": "string"
            }
          },
          {
            "name": "minUpdatedAt",
            "required": false,
            "in": "query",
            "description": "The min date of updatedAt",
            "schema": {
              "format": "date-time",
              "default": "2023-01-01T00:00:00.000Z",
              "type": "string"
            }
          },
          {
            "name": "maxUpdatedAt",
            "required": false,
            "in": "query",
            "description": "The min date of updatedAt",
            "schema": {
              "format": "date-time",
              "default": "2023-01-01T00:00:00.000Z",
              "type": "string"
            }
          },
          {
            "name": "includeDeleted",
            "required": false,
            "in": "query",
            "description": "If true, include deleted lines",
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "name": "subscriptionId",
            "required": false,
            "in": "query",
            "description": "The subscription ID",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved billing attempts",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingAttemptsResultDto"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ],
        "tags": [
          "BillingAttempts API"
        ]
      }
    }
  },
  "info": {
    "title": "Recurly Commerce API Documentation",
    "description": "Recurly Commerce API Documentation",
    "version": "1.3",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://subs.api.recurlycommerce.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "type": "http"
      }
    },
    "schemas": {
      "BillingAttemptDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "externalId": {
            "type": "string"
          },
          "subscriptionId": {
            "type": "string"
          },
          "relatedSubscriptionIds": {
            "description": "Every subscription this billing attempt covers. For a combined order, this includes the driver subscription (subscriptionId) plus every other subscription billed in the same attempt. For a solo billing attempt, this is just [subscriptionId].",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "orderId": {
            "type": "string",
            "nullable": true
          },
          "errorMsg": {
            "type": "string",
            "nullable": true
          },
          "errorCode": {
            "type": "string",
            "nullable": true
          },
          "ready": {
            "type": "boolean",
            "description": "Whether the billing attempt is still processing."
          },
          "trigger": {
            "type": "string",
            "enum": [
              "RENEWAL_TASK",
              "ANCHOR_RENEWAL_TASK",
              "DUNNING_RETRY",
              "UPDATE_PAYMENT_METHOD",
              "PROCESS_NOW"
            ],
            "nullable": true
          },
          "paymentMethodExternalId": {
            "type": "string",
            "description": "The shopify payment method card ID",
            "nullable": true
          },
          "paymentMethodType": {
            "type": "string",
            "description": "The payment method card type",
            "enum": [
              "CustomerCreditCard",
              "CustomerPaypalBillingAgreement",
              "CustomerShopPayAgreement"
            ],
            "nullable": true
          },
          "paymentMethodLast4Digits": {
            "type": "string",
            "description": "The payment method last 4 digits",
            "nullable": true
          },
          "paymentMethodExpiryMonth": {
            "type": "string",
            "description": "The payment method expiry month",
            "nullable": true
          },
          "paymentMethodExpiryYear": {
            "type": "string",
            "description": "The payment method expiry year",
            "nullable": true
          },
          "paymentMethodBrand": {
            "type": "string",
            "description": "The payment method card brand",
            "nullable": true
          },
          "paymentMethodEmail": {
            "type": "string",
            "description": "The payment method email (only shows for paypal payment type)",
            "nullable": true
          },
          "paymentMethodName": {
            "type": "string",
            "description": "The payment method name",
            "nullable": true
          },
          "baseOrderChargedAmount": {
            "type": "number",
            "description": "The charged amount of the based order associated with the billing attempt if exists"
          }
        },
        "required": [
          "id",
          "createdAt",
          "updatedAt",
          "externalId",
          "subscriptionId",
          "relatedSubscriptionIds",
          "orderId",
          "errorMsg",
          "errorCode",
          "ready",
          "trigger",
          "paymentMethodExternalId",
          "paymentMethodType",
          "paymentMethodLast4Digits",
          "paymentMethodExpiryMonth",
          "paymentMethodExpiryYear",
          "paymentMethodBrand",
          "paymentMethodEmail",
          "paymentMethodName"
        ]
      },
      "BillingAttemptsResultDto": {
        "type": "object",
        "properties": {
          "page": {
            "type": "number",
            "description": "Current page number"
          },
          "limit": {
            "type": "number",
            "description": "Number of items per page"
          },
          "totalItems": {
            "type": "number",
            "description": "Total number of items"
          },
          "totalPages": {
            "type": "number",
            "description": "Total number of pages"
          },
          "billingAttempts": {
            "description": "Array of billing attempts for the current page",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BillingAttemptDto"
            }
          }
        },
        "required": [
          "page",
          "limit",
          "totalItems",
          "totalPages",
          "billingAttempts"
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false
  }
}
```

# Sibling pages

* [Create Billing Attempt](https://docs.recurly.com/recurly-commerce/reference/createbillingattempt.md)