# Obter informações do programa de fidelidade

Retorna informações sobre o programa de fidelidade do projeto.

Endpoint: GET /projects/{project_id}/admin/program
Version: 2.0.0
Security: basicAuth

## Path parameters:

  - `project_id` (integer, required)
    ID de projeto. Você pode encontrar esse parâmetro na sua Conta de Distribuidor, próximo ao nome do projeto e na barra de endereços do navegador ao trabalhar com um projeto. O URL tem o seguinte formato: https://publisher.xsolla.com//projects/.
    Example: 44056

## Response 200 fields (application/json):

  - `id` (string)
    ID do programa de fidelidade.

  - `project_id` (integer)
    ID do projeto ao qual o programa de fidelidade pertence.

  - `name` (object,null)
    Objeto com traduções para o nome do programa de fidelidade. Chaves são códigos de idioma de duas letras minúsculas (ex.: en). Você pode encontrar a lista completa de idiomas suportados na documentação.

  - `name.en` (string,null)
    Inglês

  - `name.ar` (string,null)
    Árabe

  - `name.bg` (string,null)
    Búlgaro

  - `name.cn` (string,null)
    Chinês (Simplificado)

  - `name.cs` (string,null)
    Tcheco

  - `name.de` (string,null)
    Alemão

  - `name.es` (string,null)
    Espanhol (Espanha)

  - `name.fr` (string,null)
    Francês

  - `name.he` (string,null)
    Hebraico

  - `name.it` (string,null)
    Italiano

  - `name.ja` (string,null)
    Japonês

  - `name.ko` (string,null)
    Coreano

  - `name.pl` (string,null)
    Polonês

  - `name.pt` (string,null)
    Português

  - `name.ro` (string,null)
    Romeno

  - `name.ru` (string,null)
    Russo

  - `name.th` (string,null)
    Tailandês

  - `name.tr` (string,null)
    Turco

  - `name.tw` (string,null)
    Chinês (Tradicional)

  - `name.vi` (string,null)
    Vietnamita

  - `name.km` (string,null)
    Khmer

  - `name.id` (string,null)
    Indonésio

  - `name.lo` (string,null)
    Lao

  - `name.my` (string,null)
    Birmanês

  - `name.ph` (string,null)
    Filipino

  - `name.ne` (string,null)
    Nepalês

  - `description` (object,null)
    Objeto com traduções para a descrição do programa de fidelidade. Chaves são códigos de idioma de duas letras minúsculas (ex.: en). Você pode encontrar a lista completa de idiomas suportados na documentação.

  - `external_id` (string)
    ID do programa de fidelidade no seu sistema.

  - `is_active` (boolean)
    Se o programa de fidelidade ainda está ativo ou não.

  - `spend_max_threshold` (number)
    Parcela máxima do preço de um pedido, em porcentagem, que um usuário pode pagar com pontos de fidelidade.

  - `cashback_policy` (object)
    Regras para conceder pontos de fidelidade ao usuário como cashback para compras.

  - `cashback_policy.type` (string)
    Tipo de cálculo de cashback: static — um porcentual fixo é aplicado a todos os pedidos; dynamic — a porcentagem depende da faixa de quantia do pedido.
    Enum: "static", "dynamic"

  - `cashback_policy.ranges` (array)
    As faixas de quantia do pedido com a porcentagem de cashback para cada faixa.

  - `cashback_policy.ranges.min` (string)
    Quantia mínima do pedido para a faixa (inclusiva).

  - `cashback_policy.ranges.max` (string)
    Quantia máxima do pedido para a faixa (inclusiva). Use inf para não estabelecer um limite.

  - `cashback_policy.ranges.currency_code` (string)
    Moeda da faixa no formato ISO 4217.

  - `cashback_policy.ranges.percentage` (string)
    Porcentagem de cashback para pedidos dentro da faixa.

## Response 404 fields (application/json):

  - `message` (string)
    Descrição de erro curta.
    Example: "loyalty program not found."


## Response 401 fields