---
title: "Lists points set to expire within the specified date range (paginated)."
method: POST
path: "/v1/pvt/Points/toexpire"
tags: ["Points"]
---

# Lists points set to expire within the specified date range (paginated).

`POST /v1/pvt/Points/toexpire`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pvt/Points/toexpire`
- Auth: HTTP basic

Retrieves a paginated list of points scheduled to expire.

## Request body

- ExpiringPointsRequest: Request filter for retrieving expiring points via the external API.
  - `PageNumber` integer: Pagenation number
  - `PageSize` integer: Amount of items per page, Max size is 50 items per page.
  - `From` string, date-time, nullable: Optional start date for the expiration period (inclusive). Filters points expiring on or after this date. Expected format: ISO 8601 (e.g., "2023-10-27T00:00:00Z").
  - `To` string, date-time, nullable: Optional end date for the expiration period (inclusive). Filters points expiring on or before this date. Expected format: ISO 8601 (e.g., "2023-11-27T23:59:59Z").

## Response `200`

A paginated list of expiring points.

- BaseApiListResultOfApiExpiringPointListItem
  - `Items` object[]
    - `Id` integer
    - `PointId` integer: The ID of the point record.
    - `ExpirationDate` string, date-time, nullable: The calculated date when the points will expire.
    - `Points` integer: The number of points expiring.
    - `ReasonType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19: 0 = Purchase 1 = Signup 2 = Birthday 3 = Ordinary 4 = Reward 5 = Review 6 = Refund 7 = Expire 8 = Referral 9 = SocialMediaFollowFacebook 10 = SocialMediaFollowInstagram 11 = PartialOrderRefund 12 = Quiz 13 = CustomObjective 14 = ReferralAffiliate 15 = SocialMediaFollowLinkedin 16 = SocialMediaFollowTikTok 17 = Campaign 18 = Participation 19 = Fitness
    - `GenerationDate` string, date-time: The date when the points were originally generated.
    - `CustomerId` integer: The ID of the customer these points belong to.
    - `CustomerName` string: The name of the customer.
    - `CustomerEmail` string: The email of the customer.
    - `CustomerPhone` string: The phone number of the customer.
    - `CustomerDocument` string: The document number (e.g., CPF) of the customer.
    - `BranchName` string
    - `BranchId` integer
    - `CashbackValue` number: The calculated cashback value equivalent to the expiring points.
    - `OrderOrigin` string: The origin of the order associated with the points (e.g., WEB, PDV).
    - `Salesman` string
    - `PointMetadatas` object, nullable: Point metadata key-value pairs for export.
  - `TotalItemCount` integer
  - `PageSize` integer
  - `PageNumber` integer
  - `HasNextPage` boolean

---

[API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)