Sign in
MembershipCreditRules

Update a membership credit rule

This endpoint updates a membership credit rule.

put/customers/membership-credit-rules/{creditRuleId}

Request body

membership_type_idstring uuid

Identifier of the membership tier whose members will receive this credit rule. Rules are scoped to a single tier; create separate rules per tier if benefits differ.

coupon_idstring

Identifier of the coupon template used when issuing the credit. Each application of the rule issues a fresh coupon code derived from this template; the template defines the discount amount, validity, and offerings.

coupon_namestring

Display name shown alongside the issued coupon in the customer's account (e.g. "August spa credit"). Not the redemption code; that's generated automatically. 1-120 characters.

roll_overboolean

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_signupboolean

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_useboolean

If true, the credit can be used an unlimited number of times until the expiry date.

for_lead_booker_onlyboolean

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'

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

include_upcomingboolean

When true, apply the updated rule to membership charges that are already scheduled but not yet billed — picking up rate / frequency / coupon changes for the next cycle without waiting for the new rule to organically take effect on the cycle after that. When false (default), the update only affects credits issued from the next billing cycle onwards; existing scheduled charges continue to apply the previous rule.

Example request

{
  "coupon_id": "5f1234567890abcdef123456",
  "coupon_name": "Monthly spa credit"
}

Response

The membership credit rule was 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"
  }
}

Changes

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