---
title: "Benefícios"
description: "Clube de benefícios, saldo e histórico."
---
benefitsnamespace
Clube de benefícios, saldo e histórico.
3métodos
benefitsnamespace
> Esta página é gerada automaticamente pelo `@luckymaker/sdk-generator`. Não edite manualmente.
## `getBalance`
GET/benefits/user/balance
Assinatura:
```ts
getBalance(settings?: SdkSettings): Promise
```
### Tipos
```ts
type GetBalanceResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.benefits.getBalance();
```
Testar esta função no playground
## `getCoupon`
GET/user/benefits/coupons/:id
Assinatura:
```ts
getCoupon(id: string, settings?: SdkSettings): Promise
```
### Parâmetros de rota
| Nome | Tipo |
|---|---|
| `id` | `string` |
### Tipos
```ts
type GetCouponParams = { "id": string; };
type GetCouponResponse = { "coupon": { "id": string; "status": string; "code": string | null; "pin": string | null; "activationUrl": string | null; "qrCode": string | null; "faceValue": string | null; "pointsSpent": number | null; "providerCoupon": boolean; "redeemedAt": string | null; "activatesAt": string | null; "expiresAt": string | null; "description": string | null; "howToRedeem": string | null; "item": { "id": string; "slug": string; "title": string; "thumbnailUrl": string | null; } | null; }; };
```
### Exemplo
```ts
const response = await sdk.benefits.getCoupon("string");
```
Testar esta função no playground
## `getHistory`
GET/user/benefits/history
Assinatura:
```ts
getHistory(query?: GetHistoryQuery, settings?: SdkSettings): Promise
```
### Query
| Nome | Tipo | Obrigatório |
|---|---|---|
| `page` | `number` | sim |
### Tipos
```ts
type GetHistoryQuery = { "page": number; };
type GetHistoryResponse = unknown;
```
### Exemplo
```ts
const response = await sdk.benefits.getHistory({ "page": 0 });
```
Testar esta função no playground