---
title: "Add store credits to customer account"
method: POST
path: "/api/external/add-credits"
tags: ["Points & Earn Rules"]
---

# Add store credits to customer account

`POST /api/external/add-credits`

## Headers

- `X-API-Key` string, required

## Request body

- CustomerAddCreditsLoyaltyRequestVM — Request containing customer ID/email, credits to add, and optional description
  - `credits` number, double
  - `customerEmail` string
  - `customerId` integer
  - `earnRuleId` integer
  - `note` string

## Response `200`

Store credits successfully added to customer account

- CustomerLoyaltyResponseVM
  - `achievableTierId` integer
  - `availablePoints` number, double
  - `createAt` string, date-time
  - `creditedPoints` number, double
  - `currentVipTier` string
  - `customerStatus` 'ACTIVE' | 'INACTIVE' | 'EXCLUDED' | 'EXCLUDED_BY_CUSTOMER'
  - `dob` string, date
  - `expiringPointsAmount` number, double
  - `pendingPoints` number, double
  - `pointsExpireAt` string, date-time
  - `referralLink` string
  - `referredCompleted` integer
  - `rewardedForCreatingAccount` boolean
  - `rewardedForFacebook` boolean
  - `rewardedForInstagram` boolean
  - `rewardedForNewsLetter` boolean
  - `rewardedForPinterest` boolean
  - `rewardedForSharingOnFacebook` boolean
  - `rewardedForSharingOnX` boolean
  - `rewardedForSms` boolean
  - `rewardedForTiktok` boolean
  - `rewardedForTwitter` boolean
  - `rewardedForYoutube` boolean
  - `rewards` CustomerReward[]
    - `amount` number, double
    - `createAt` string, date-time, required
    - `customerId` integer, required
    - `description` string
    - `discountCode` string, required
    - `discountCodeId` string
    - `expireDate` string, date-time
    - `id` integer
    - `lastExpiryReminderSentDate` string, date-time
    - `orderId` integer
    - `orderName` string
    - `pointRedeemRuleId` integer
    - `pointTransactionId` integer
    - `productData` string
    - `rewardType` 'STORE_CREDIT' | 'DISCOUNT_CODE' | 'POINTS'
    - `shop` string, required
    - `status` 'USED' | 'UNUSED' | 'REFUNDED' | 'EXPIRED' | 'SUBSCRIPTION_ACTIVE' | 'CANCELED', required
    - `usageCount` integer
    - `usedAt` string, date-time
    - `variantId` integer
  - `spentAmount` number, double
  - `storeCreditBalance` number, double
  - `storeCreditCurrency` string
  - `vipTierExpiredAt` string, date-time
  - `vipTierSpentAmount` number, double

## Other responses

- `400` — Invalid request - Invalid customer or credit amount
- `401` — Unauthorized - Invalid or missing X-API-Key

---

[API](https://skmtc.net/appstle/apis/admin-apis.md) · [All operations](https://skmtc.net/appstle/apis/admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/appstle/admin-apis/versions/fd4af3eaa936/schema)