Adjust prepaid credits

This endpoint allows you to adjust the prepaid credit balance of a subscription by adding, deducting, or setting a final credit balance.

patch/2026-04/subscription/{subscriptionId}/credits

Request

Base URL
https://api.loopsubscriptions.com/admin
URL
https://api.loopsubscriptions.com/admin/2026-04/subscription/{subscriptionId}/credits
Auth
API key in header X-Loop-Token

Path parameters

subscriptionIdstring required

The unique identifier of the subscription in Loop

Request body

amountType'DIFFERENCE' | 'FINAL' required

Determines how the provided amount is applied to the subscription's prepaid credit balance

amountinteger required

The amount to add, deduct, or set as the prepaid credit balance

reasonstring required

The reason for adjusting the prepaid credit balance

Response

successboolean

Indicates whether the credit balance adjustment was processed successfully.

messagestring

A message describing the result of the request.

codestring

The response code indicating the outcome of the request

pageInfounknown

Example response

{
  "success": true,
  "message": "Credits updated successfully",
  "data": {
    "oldBalance": 3225,
    "newBalance": 3001,
    "adjustedAmount": -224,
    "reason": "Requested by customer due to an issue around last order being skipped.",
    "userEmail": "zapier token"
  },
  "code": "SUCCESS"
}

Changes

No recorded changes to this operation across all 1 revision of this API.