> ## Documentation Index
> Fetch the complete documentation index at: https://partner-help.letsdothis.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a membership scheme's settings

> Returns how one of your schemes treats its members: shared addresses, the renewal access grace period, collecting missed renewals, what members can change themselves, cooling-off windows and where checkout offers the membership.

Settings your organization never chose show the value that applies. Only your organization's API keys can read this, not member tokens.

> [!NOTE]
>
> This endpoint is in beta: its request and response contract can still change while it's being developed.


## OpenAPI

````yaml /openapi.json get /v0/membership-schemes/{schemeId}/settings
openapi: 3.1.0
info:
  title: Let's Do This API
  version: 0.1.0
  description: >
    The full reference — getting started, pagination, error responses, rate
    limits and the changelog — lives at

    [partner-help.letsdothis.com/api-reference](https://partner-help.letsdothis.com/api-reference/overview).

    This page is the interactive OpenAPI view of the same specification.


    # Authentication


    Create an API key from **Settings** → **Credentials** in your Let's Do This
    account and send it as a bearer token:


    ```bash

    curl --request GET \
     --url "https://api.letsdothis.com/v0/participants" \
     --header "Authorization: Bearer YOUR-API-KEY"
    ```


    Keep the key secret: it identifies your organization, so do not ship it in a
    website or native app. If a key is exposed,

    revoke it from the same section and create a replacement.


    # OpenAPI schema


    Download the [OpenAPI schema](https://api.letsdothis.com/documentation/json)
    to use with Postman or an OpenAPI client

    generator.
servers:
  - url: https://api.letsdothis.com
    description: Production
  - url: https://api.staging.letsdothis.com
    description: Staging
security:
  - bearerAuth: []
tags:
  - name: Events
    x-group: Events
    description: Events that participants can register for.
  - name: EventOccurrences
    x-group: Event occurrences
    description: >-
      Event occurrences scoped to the organizer associated with your Public API
      credentials. Unlike the public Events catalog, results are limited to your
      own events.
  - name: Races
    x-group: Races
    description: >-
      Races within an event occurrence. An event occurrence may have one or more
      races, for example a 5K and a 10K within the same race day.
  - name: Tickets
    x-group: Tickets
    description: Tickets that are available for events.
  - name: BookingForms
    x-group: Booking forms
    description: >-
      Booking forms define the questions a booker answers when registering for a
      ticket. A ticket usually references a single booking form, so expect zero
      or one, while a booking form may be shared across multiple tickets.
  - name: BookingFormFields
    x-group: Booking form fields
    description: >-
      Booking form fields are the individual questions on a booking form — their
      type, label, options, and whether an answer is required. A field can be
      reused across multiple forms.
  - name: Bookings
    x-group: Bookings
    description: >-
      Bookings are the transaction record for a registration. A booking may
      contain one or more participants (entries).
  - name: Membership
    x-group: Memberships
    description: >-
      Membership schemes, purchased policies and the seats on them, owned by
      your organizer. Policies are billing contracts; a seat is one person's
      place on a policy.
  - name: Participant
    x-group: Participants
    description: Participants are users who successfully booked an event.
  - name: LineItem
    x-group: Line items
    description: Financial details related to individual items within transactions.
  - name: AddOns
    x-group: Add-ons
    description: >-
      Your add-on products, such as merchandise or extras, that participants buy
      with their entry. Imported products keep the ids you gave them.
  - name: DiscountCodes
    x-group: Discount codes
    description: >-
      Discount codes participants enter at checkout to reduce the price of a
      booking.
  - name: Credits
    x-group: Credits
    description: >-
      Credits are balances participants can spend at checkout, identified by
      their email address.
  - name: Referrals
    x-group: Referrals
    description: >-
      Referral programs, the referrers registered on them, and asynchronous
      imports of historical referrals.
  - name: Teams
    x-group: Teams
    description: >-
      Teams group participants of an event occurrence under a team program.
      Teams can be imported for participants whose bookings were imported.
  - name: Application
    x-group: Applications
    description: >-
      Applications are created when a user applies for tickets that are set up
      to require an application process, such as balloted or "Good For Age"
      entries.
  - name: Partner
    x-group: Partners
    description: >-
      Partners that were created by the organization who can have Reserved
      Entries assigned to them.
  - name: ReservedEntries
    x-group: Reserved entries
    description: >-
      Reserved Entries are entries that are reserved for a partner. After being
      assigned, the partner can then allocate these entries to participants.
  - name: Timing
    x-group: Timing
    description: >-
      Timing providers push bib numbers and bib-pack shipments back to Let's Do
      This for the startlist entries they received. Available to select timing
      partners only.
  - name: Identity
    x-group: API key
    description: >-
      What your API key can reach. Available to every key, including scoped
      ones.
paths:
  /v0/membership-schemes/{schemeId}/settings:
    get:
      tags:
        - Membership
      summary: Get a membership scheme's settings
      description: >-
        Returns how one of your schemes treats its members: shared addresses,
        the renewal access grace period, collecting missed renewals, what
        members can change themselves, cooling-off windows and where checkout
        offers the membership.


        Settings your organization never chose show the value that applies. Only
        your organization's API keys can read this, not member tokens.
      parameters:
        - schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
          in: path
          name: schemeId
          required: true
          description: The id of one of your membership schemes.
      responses:
        '200':
          description: >-
            The scheme's settings, including defaults your organization never
            changed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MembershipSchemeSettings'
        '404':
          description: Your organization has no membership scheme with this id.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - statusCode
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - MEMBERSHIP_RESOURCE_NOT_FOUND
                  statusCode:
                    type: integer
                    enum:
                      - 404
                  message:
                    type: string
components:
  schemas:
    MembershipSchemeSettings:
      title: MembershipSchemeSettings
      type: object
      properties:
        id:
          type: string
        membersShareAddress:
          type: boolean
          description: >-
            Whether every member on a policy lives at the primary member's
            address.
        renewalAccessGraceDays:
          type:
            - number
            - 'null'
          description: >-
            Whole days, 0 to 30, after a member's paid period ends that they
            keep access while their renewal is unpaid. Null when none is set:
            then only a renewal still awaiting payment keeps access, for up to 7
            days.
        missedCycleCollection:
          type: string
          enum:
            - STOP_WHEN_SUPERSEDED
            - COLLECT_ARREARS
          description: >-
            Once a later renewal is paid, whether an older unpaid renewal stops
            being collected (STOP_WHEN_SUPERSEDED) or is still collected
            (COLLECT_ARREARS).
        memberChangeRules:
          $ref: '#/components/schemas/MembershipSchemeMemberChangeRules'
        coolingOff:
          $ref: '#/components/schemas/MembershipSchemeCoolingOff'
        coolingOffRefund:
          $ref: '#/components/schemas/MembershipSchemeCoolingOffRefund'
        upsellAvailability:
          anyOf:
            - $ref: '#/components/schemas/MembershipSchemeUpsellAvailability'
            - type: 'null'
          description: Null when checkout offers the membership on every event occurrence.
      required:
        - id
        - membersShareAddress
        - renewalAccessGraceDays
        - missedCycleCollection
        - memberChangeRules
        - coolingOff
        - coolingOffRefund
        - upsellAvailability
      additionalProperties: false
      description: >-
        How a membership scheme treats its members' access, renewals,
        cancellations and plan changes. Only your organizer's API keys can read
        these; member tokens cannot. A setting your organizer never chose reads
        as the value that applies.
    MembershipSchemeMemberChangeRules:
      title: MembershipSchemeMemberChangeRules
      type: object
      properties:
        upgrade:
          $ref: '#/components/schemas/MembershipSchemeOfferingChangeRule'
        downgrade:
          $ref: '#/components/schemas/MembershipSchemeOfferingChangeRule'
        swap:
          $ref: '#/components/schemas/MembershipSchemeOfferingChangeRule'
        cancellation:
          $ref: '#/components/schemas/MembershipSchemeCancellationRule'
        memberMayChangeTier:
          type: boolean
          description: >-
            Whether members may move to another tier. A move changing tier and
            plan needs both.
        memberMayChangePlan:
          type: boolean
          description: Whether members may move to another plan, changing who is covered.
      required:
        - upgrade
        - downgrade
        - swap
        - cancellation
        - memberMayChangeTier
        - memberMayChangePlan
      additionalProperties: false
      description: >-
        What members may change about their own membership. Your organizer and
        Let's Do This aren't bound by these rules.
    MembershipSchemeCoolingOff:
      title: MembershipSchemeCoolingOff
      type: object
      properties:
        afterJoining:
          type: string
        afterRenewal:
          type: string
        afterOfferingChange:
          type: string
      required:
        - afterJoining
        - afterRenewal
        - afterOfferingChange
      additionalProperties: false
      description: >-
        How long after each event a member may cancel their whole membership
        straight away. Each is an ISO 8601 duration such as P14D; PT0S when the
        window is off.
    MembershipSchemeCoolingOffRefund:
      title: MembershipSchemeCoolingOffRefund
      type: object
      properties:
        mode:
          type: string
          enum:
            - ESCALATE_TO_SUPPORT
            - FULL
            - PRO_RATA_BY_DAYS
          description: >-
            ESCALATE_TO_SUPPORT has Let's Do This support decide the refund;
            FULL refunds the whole payment for the period; PRO_RATA_BY_DAYS
            refunds it pro rata to the whole days left in the period.
        cover:
          type: string
          enum:
            - EO_COVERS_REVERSAL_ONLY
            - EO_COVERS_INCLUDING_LDT_COMMISSION
            - EO_COVERS_NOTHING
          description: >-
            Who pays for the refund: your organizer reverses its share only
            (EO_COVERS_REVERSAL_ONLY), its share and the Let's Do This
            commission (EO_COVERS_INCLUDING_LDT_COMMISSION), or nothing
            (EO_COVERS_NOTHING).
        refundOrderProcessingFee:
          type: boolean
          description: >-
            Whether the refund gives back the order processing fee. False, the
            default, has the member bear it, so the refund leaves it out.
      required:
        - mode
        - cover
        - refundOrderProcessingFee
      additionalProperties: false
      description: >-
        How a member who cancels inside a cooling-off window is refunded. A
        scheme that never chose reads as sending every such refund to Let's Do
        This support.
    MembershipSchemeUpsellAvailability:
      title: MembershipSchemeUpsellAvailability
      type: object
      properties:
        type:
          type: string
          enum:
            - OPT_IN
            - OPT_OUT
        eventOccurrenceIds:
          type: array
          items:
            type: string
      required:
        - type
        - eventOccurrenceIds
      additionalProperties: false
      description: >-
        Where checkout offers the membership alongside an event entry: OPT_IN
        offers it only on the listed event occurrences, OPT_OUT on every
        occurrence except them.
    MembershipSchemeOfferingChangeRule:
      title: MembershipSchemeOfferingChangeRule
      type: object
      properties:
        memberMay:
          type: boolean
          description: Whether members may make this move themselves.
        minimumLeadTime:
          type: string
          description: >-
            Notice before the move takes effect, as an ISO 8601 duration such as
            P14D; PT0S for none.
        memberMayChangeMidCycle:
          type: boolean
          description: >-
            Whether members may make the move straight away, rather than only
            from a renewal. Only with no notice: with notice set, they move at a
            renewal once it has passed.
      required:
        - memberMay
        - minimumLeadTime
        - memberMayChangeMidCycle
      additionalProperties: false
      description: >-
        One kind of move a member makes between offerings, judged by price
        alone.
    MembershipSchemeCancellationRule:
      title: MembershipSchemeCancellationRule
      type: object
      properties:
        minimumLeadTime:
          type: string
          description: >-
            Notice a member gives before their cancellation takes effect,
            outside cooling-off, as an ISO 8601 duration such as P1M; PT0S for
            none.
        memberMayChangeMidCycle:
          type: boolean
          description: >-
            Whether members may cancel mid-cycle rather than only from a
            renewal: straight away with no notice, or once the notice has
            passed.
      required:
        - minimumLeadTime
        - memberMayChangeMidCycle
      additionalProperties: false
      description: >-
        When members may cancel. A member can always cancel, so only the timing
        is configurable. A cooling-off window also lets a member cancel straight
        away, whatever this says.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.