---
agentTools:
  projectIndex: https://zafepay.readme.io/llms.txt
---

# List subscription buyers

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Onlypays",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.staging.zafepay.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/integration/subscription_buyers": {
      "get": {
        "summary": "List subscription buyers",
        "description": "",
        "operationId": "list-subscription-buyers",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Header to access api endpoints (Check the authentication section).",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Comma-separated filter by status of the subscription buyer",
            "schema": {
              "type": "string",
              "enum": [
                "pending",
                "active",
                "indebt",
                "canceled",
                "active_pending",
                "finished",
                "paused",
                "problem_on_charge"
              ]
            }
          },
          {
            "name": "recurrence",
            "in": "query",
            "description": "Comma-separated filter by subscription recurrences",
            "schema": {
              "type": "string",
              "enum": [
                "week",
                "month",
                "quarter",
                "semester",
                "year",
                "bimonth",
                "custom"
              ]
            }
          },
          {
            "name": "due_start_date",
            "in": "query",
            "description": "Filter by current installment due_date (From)",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "due_end_date",
            "in": "query",
            "description": "Filter by current installment due_date (To)",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "subscription_start_date",
            "in": "query",
            "description": "Filter by current activated_at date (From)",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "subscription_end_date",
            "in": "query",
            "description": "Filter by activated_at date (To)",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number to retrieve from a paginated collection",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": [\n        {\n            \"id\": \"e1a2cdc9-1ad5-4947-b641-84a95675d063\",\n            \"buyer\": {\n                \"id\": \"0d27afe0-7a02-41e1-9494-a955c21c0a3a\",\n                \"created_at\": \"2023-10-10T12:35:13\",\n                \"email\": \"jhonsmith@gmail.com\",\n                \"external_id\": \"customer003\",\n                \"name\": \"Jhon Smith\",\n                \"updated_at\": \"2023-10-10T12:40:11\"\n            },\n            \"created_at\": \"2023-10-10T16:04:54\",\n            \"current_installment\": {\n                \"amount\": 40990,\n                \"due_date\": \"2023-10-10\",\n                \"currency\": \"CLP\",\n              \t\"external_id\": null,\n                \"status\": \"pending\",\n                \"payment_date\": null,\n                \"created_at\": \"2023-10-10T16:04:54\",\n                \"updated_at\": \"2023-10-10T16:04:54\"\n            },\n            \"external_id\": null,\n            \"extra_fields\": {\n                \"Rut\": \"11.111.111-1\"\n            },\n            \"payment_url\": \"https://staging.zafepay.com/subscription_buyers/da7b6q1b-c744-4c2e-9749-f935a4ce9dab\",\n            \"status\": \"active\",\n            \"subscription_id\": \"a3a50c65-0dbc-4fd9-9735-b3c36feb37ea\",\n            \"updated_at\": \"2023-10-10T16:04:54\"\n        }\n    ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "e1a2cdc9-1ad5-4947-b641-84a95675d063"
                          },
                          "buyer": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "0d27afe0-7a02-41e1-9494-a955c21c0a3a"
                              },
                              "created_at": {
                                "type": "string",
                                "example": "2023-10-10T12:35:13"
                              },
                              "email": {
                                "type": "string",
                                "example": "jhonsmith@gmail.com"
                              },
                              "external_id": {
                                "type": "string",
                                "example": "customer003"
                              },
                              "name": {
                                "type": "string",
                                "example": "Jhon Smith"
                              },
                              "updated_at": {
                                "type": "string",
                                "example": "2023-10-10T12:40:11"
                              }
                            }
                          },
                          "created_at": {
                            "type": "string",
                            "example": "2023-10-10T16:04:54"
                          },
                          "current_installment": {
                            "type": "object",
                            "properties": {
                              "amount": {
                                "type": "integer",
                                "example": 40990,
                                "default": 0
                              },
                              "due_date": {
                                "type": "string",
                                "example": "2023-10-10"
                              },
                              "currency": {
                                "type": "string",
                                "example": "CLP"
                              },
                              "external_id": {},
                              "status": {
                                "type": "string",
                                "example": "pending"
                              },
                              "payment_date": {},
                              "created_at": {
                                "type": "string",
                                "example": "2023-10-10T16:04:54"
                              },
                              "updated_at": {
                                "type": "string",
                                "example": "2023-10-10T16:04:54"
                              }
                            }
                          },
                          "external_id": {},
                          "extra_fields": {
                            "type": "object",
                            "properties": {
                              "Rut": {
                                "type": "string",
                                "example": "11.111.111-1"
                              }
                            }
                          },
                          "payment_url": {
                            "type": "string",
                            "example": "https://staging.zafepay.com/subscription_buyers/da7b6q1b-c744-4c2e-9749-f935a4ce9dab"
                          },
                          "status": {
                            "type": "string",
                            "example": "active"
                          },
                          "subscription_id": {
                            "type": "string",
                            "example": "a3a50c65-0dbc-4fd9-9735-b3c36feb37ea"
                          },
                          "updated_at": {
                            "type": "string",
                            "example": "2023-10-10T16:04:54"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "64c97d0ad3b2f2002d150a5d:65259dcb65856d00601040f5"
}
```