# Get loyalty program information

Returns information about the project's loyalty program.

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

## Path parameters:

  - `project_id` (integer, required)
    Project ID. You can find this parameter in your Publisher Account next to the project name and in the browser address bar when working with a project. The URL has the following format: https://publisher.xsolla.com//projects/.
    Example: 44056

## Response 200 fields (application/json):

  - `id` (string)
    Loyalty program ID.

  - `project_id` (integer)
    ID of the project the loyalty program belongs to.

  - `name` (object,null)
    Object with localizations for the loyalty program's name. Keys are two-letter lowercase language codes (e.g., en). You can find the full list of supported languages in the documentation.

  - `name.en` (string,null)
    English

  - `name.ar` (string,null)
    Arabic

  - `name.bg` (string,null)
    Bulgarian

  - `name.cn` (string,null)
    Chinese (Simplified)

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

  - `name.de` (string,null)
    German

  - `name.es` (string,null)
    Spanish (Spain)

  - `name.fr` (string,null)
    French

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

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

  - `name.ja` (string,null)
    Japanese

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

  - `name.pl` (string,null)
    Polish

  - `name.pt` (string,null)
    Portuguese

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

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

  - `name.th` (string,null)
    Thai

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

  - `name.tw` (string,null)
    Chinese (Traditional)

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

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

  - `name.id` (string,null)
    Indonesian

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

  - `name.my` (string,null)
    Burmese

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

  - `name.ne` (string,null)
    Nepali

  - `description` (object,null)
    Object with localizations for the loyalty program's description. Keys are two-letter lowercase language codes (e.g., en). You can find the full list of supported languages in the documentation.

  - `description.en` (string,null)
    English

  - `description.ar` (string,null)
    Arabic

  - `description.bg` (string,null)
    Bulgarian

  - `description.cn` (string,null)
    Chinese (Simplified)

  - `description.cs` (string,null)
    Czech

  - `description.de` (string,null)
    German

  - `description.es` (string,null)
    Spanish (Spain)

  - `description.fr` (string,null)
    French

  - `description.he` (string,null)
    Hebrew

  - `description.it` (string,null)
    Italian

  - `description.ja` (string,null)
    Japanese

  - `description.ko` (string,null)
    Korean

  - `description.pl` (string,null)
    Polish

  - `description.pt` (string,null)
    Portuguese

  - `description.ro` (string,null)
    Romanian

  - `description.ru` (string,null)
    Russian

  - `description.th` (string,null)
    Thai

  - `description.tr` (string,null)
    Turkish

  - `description.tw` (string,null)
    Chinese (Traditional)

  - `description.vi` (string,null)
    Vietnamese

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

  - `description.id` (string,null)
    Indonesian

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

  - `description.my` (string,null)
    Burmese

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

  - `description.ne` (string,null)
    Nepali

  - `external_id` (string)
    Loyalty program ID in your system.

  - `is_active` (boolean)
    Whether the loyalty program is active.

  - `spend_max_threshold` (number)
    Maximum share of an order's price, in percent, that a user can pay with loyalty points.

  - `cashback_policy` (object)
    Rules for granting loyalty points to the user as cashback for purchases.

  - `cashback_policy.type` (string)
    Cashback calculation type: static — a fixed percentage is applied to all orders; dynamic — the percentage depends on the order amount range.
    Enum: "static", "dynamic"

  - `cashback_policy.ranges` (array)
    Order amount ranges with the cashback percentage for each range.

  - `cashback_policy.ranges.min` (string)
    Minimum order amount for the range (inclusive).

  - `cashback_policy.ranges.max` (string)
    Maximum order amount for the range (inclusive). Use inf for no upper limit.

  - `cashback_policy.ranges.currency_code` (string)
    Currency of the range in the ISO 4217 format.

  - `cashback_policy.ranges.percentage` (string)
    Cashback percentage for orders within the range.

## Response 404 fields (application/json):

  - `message` (string)
    Short error description.
    Example: "loyalty program not found."


## Response 401 fields