Sign in
MembershipCreditRules

List membership credit rules

This endpoint retrieves all the membership credit rules associated with a brand, and is typically filtered by membership type.

get/customers/membership-credit-rules

Query parameters

brand_idstring uuid

Filter membership credit rules by brand ID

membership_type_idstring uuid

Filter membership credit rules by membership type ID

issue_on_signupboolean

When true, only membership credit rules that are issued on signup are returned

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The membership credit rules were successfully retrieved

Example response

{
  "data": [
    {
      "membership_type": {
        "name": "Gold tier"
      },
      "issuing_frequency": "P1M",
      "created_at": "2026-01-01T00:00:00+00:00",
      "updated_at": "2026-01-01T00:00:00+00:00"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

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