v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Streaks

Fetch Streaks related details for a given subscription ID in a specific locale

get/2023-10/subscription/{subscriptionId}/streak

Path parameters

subscriptionIdinteger required

The unique identifier for a subscription in Loop.

Query parameters

localestring

Response

200

successboolean

messagestring

codestring

{"stackTrail":"paths:/2023-10/subscription/{subscriptionId}/streak:get:responses:200:content:application/json:schema:properties:pageInfo","oasType":"schema","type":"unknown"}

Example response

{
  "success": true,
  "message": "Fetched subscription streak details successfully",
  "data": {
    "programName": "New streak",
    "streakLength": 5,
    "gracePeriod": 7,
    "status": "ACTIVE",
    "nextDueDate": "2025-12-07T08:00:00.000Z",
    "rewards": [
      {
        "orderNumber": 1,
        "rewardType": "NONE",
        "texts": {
          "rewardTitle": "Great work with the first move!"
        }
      }
    ]
  },
  "code": "SUCCESS"
}