---
title: "List membership credit rules"
method: GET
path: "/customers/membership-credit-rules"
tags: ["MembershipCreditRules"]
---

# List membership credit rules

`GET /customers/membership-credit-rules`

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

## Query parameters

- `brand_id` string, uuid
- `membership_type_id` string, uuid
- `issue_on_signup` boolean
- `page` integer
- `per_page` integer

## Response `200`

The membership credit rules were successfully retrieved

- object
  - `data` MembershipCreditRule[], required
    - `id` string, uuid, required — The ID of the credit rule
    - `membership_type_id` string, uuid, required — The ID of the membership type this rule relates to
    - `membership_type` SchemasMembershipTypeSummary
      - `id` string, uuid, required — The ID of the membership type this rule belongs to
      - `name` string, required — The name of the membership type this rule belongs to
    - `coupon_id` string, required — The ID of the coupon which will be issued
    - `coupon_name` string, required — The name of the coupon which will be issued
    - `coupon_description` string, required — The description of the coupon which will be issued
    - `roll_over` boolean, required — If true, unused credits will roll over to the next month. Otherwise, any unused credits will be marked as expired on the next billing period.
    - `issue_on_signup` boolean, required — If true, the credit will be issued when new customers sign up for the given membership type. Otherwise, the credit will be issued only on the monthly billing schedule.
    - `multi_use` boolean, required — If true, the credit can be used an unlimited number of times until the expiry date.
    - `for_lead_booker_only` boolean, required — If true, the credit will only be issued for the lead booker of an order. If false, the credit will be issued for all guests on the order, including non-members.
    - `issuing_frequency` 'billing_cycle' | 'P0D' | 'P1M' | 'P3M' | 'P6M' | 'P1Y', required — The frequency that this credit is issued. The duration is specified as an ISO8601 duration string. See https://en.wikipedia.org/wiki/ISO_8601#Durations
    - `created_at` string, date-time, required — The date and time which the credit rule was created
    - `updated_at` string, date-time, required — The date and time which the credit rule was last updated
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)