Base URL

Use the following base URL to access the API:

{shopify_store}/apps/subscribfy-api/v1/loyalty/...

<aside> 💡

Each request is evaluated and must contain the parameter key which equates to your Subscribfy API Key

CleanShot 2025-07-31 at 18.11.42@2x.png

</aside>

API Endpoints

Get created rules

Request Type: GET

{shopify_store}/apps/subscribfy-api/v1/loyalty/rules

Available params

Parameter Required Valid Values Description
type No birthday_reward, goal_spend , points_for_purchases , punch_card , create_account , email_subscription , sms_subscription , social , referral , customer_tag , reviews , membership_recharge_punch_card Filter the rules returned based on the type.
status No 1 , 0
1 - Active
0 - Inactive Filter the rules returned based on their current status.

Response:

200 - OK

[
    {
        "id": 2,
        "status": 1,
        "type": "points_for_purchases",
        "name": "Points For Purchases",
        "description": null,
        "rules": {
            "customer_settings": {
                "apply_to": "specific",
                "action": "exclude",
                "tags": [
                    "EXM: VIP: Active"
                ]
            },
            "product_ids": [],
            "collection_ids": [],
            "rewards_customer": false
        },
        "reward_rules": {
            "type": "points",
            "message": "Make a purchase",
            "amount": 1,
            "rewards_customer": true
        },
        "start_date": "2025-04-07T00:00:00.000000Z",
        "end_date": null,
        "completion_progress": null
    },
    ...
]

422 - Unprocessable Content

{
    "error": true,
    "message": "Sorry, the information provided is not valid.",
    "data": "{\\"{field}\\":[\\"{error message regarding a field's validation}\\"]}"
}

If the customer is logged on the store, the Success response will contain info about a rule’s completion_progress . Currently, only rules of type membership_recharge_punch_card will contain info about a customer’s progress through the rule. Alternatively you can send the shopify id of the customer as parameter customer_id

[
    {
        "status": 1,
        "type": "membership_recharge_punch_card",
        "name": "Recharge Punch Card",
        ...
        "start_date": "2025-05-16T00:00:00.000000Z",
        "end_date": null,
        "completion_progress": {
            "progress": 66.66666666666667,
            "desired_value": 3,
            "actual_value": 5,
            "normalized_value": 2
        }
    }
]

progress - Amount in % about the customer’s progress on the loyalty rule

desired_value - The number of recharges needed to complete the rule

actual_value - Customer’s total number of recharges

normalized_value - The normalized number of recharges based on the desired value