> ## 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.

# List purchasable membership offerings

> Returns current purchasable offerings for an owned scheme, including tier, family plan composition, benefits and current price. This is what a new member or plan change would cost; an existing policy can be on a retired price. Disabled schemes and offerings without a complete price are omitted.

> [!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-offerings
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 memberships on them, owned
      by your organizer. Policies are billing contracts; a membership is one
      person 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: >-
      Organizer-owned products that can be purchased and allocated to
      participants. Imported products retain stable external identities.
  - 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: 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-offerings:
    get:
      tags:
        - Membership
      summary: List purchasable membership offerings
      description: >-
        Returns current purchasable offerings for an owned scheme, including
        tier, family plan composition, benefits and current price. This is what
        a new member or plan change would cost; an existing policy can be on a
        retired price. Disabled schemes and offerings without a complete price
        are omitted.
      parameters:
        - schema:
            type:
              - number
              - 'null'
            minimum: 1
            maximum: 500
            example: 100
          in: query
          name: page[size]
          required: false
          description: >-
            The number of entries to return per page. Range between 1 - 500,
            defaults to 100
        - schema:
            type:
              - string
              - 'null'
          in: query
          name: page[after]
          required: false
          description: >-
            Accepts an existing page cursor. For more details see the definition
            of PageCursor in the response.
        - schema:
            type:
              - string
              - 'null'
          in: query
          name: page[before]
          required: false
          description: >-
            Accepts an existing page cursor. For more details see the definition
            of PageCursor in the response.
        - schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
          in: query
          name: schemeId
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedMembershipOfferings'
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - statusCode
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - MEMBERSHIP_RESOURCE_NOT_FOUND
                      - MEMBERSHIP_INVALID_REQUEST
                      - MEMBERSHIP_PORTAL_CONFIGURATION_REQUIRED
                      - MEMBERSHIP_BILLING_UNAVAILABLE
                      - MEMBERSHIP_FROZEN
                      - MEMBERSHIP_ALREADY_CANCELLED
                    description: >-
                      Stable error identifier. RESOURCE_NOT_FOUND covers missing
                      and foreign resources alike. INVALID_REQUEST covers
                      malformed input or fields that cannot be edited.
                      PORTAL_CONFIGURATION_REQUIRED requires account setup;
                      BILLING_UNAVAILABLE means billing cannot be resolved or
                      reached. FROZEN and ALREADY_CANCELLED are reserved for
                      future lifecycle writes.
                  statusCode:
                    type: integer
                  message:
                    type: string
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - statusCode
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - MEMBERSHIP_RESOURCE_NOT_FOUND
                      - MEMBERSHIP_INVALID_REQUEST
                      - MEMBERSHIP_PORTAL_CONFIGURATION_REQUIRED
                      - MEMBERSHIP_BILLING_UNAVAILABLE
                      - MEMBERSHIP_FROZEN
                      - MEMBERSHIP_ALREADY_CANCELLED
                    description: >-
                      Stable error identifier. RESOURCE_NOT_FOUND covers missing
                      and foreign resources alike. INVALID_REQUEST covers
                      malformed input or fields that cannot be edited.
                      PORTAL_CONFIGURATION_REQUIRED requires account setup;
                      BILLING_UNAVAILABLE means billing cannot be resolved or
                      reached. FROZEN and ALREADY_CANCELLED are reserved for
                      future lifecycle writes.
                  statusCode:
                    type: integer
                  message:
                    type: string
components:
  schemas:
    PagedMembershipOfferings:
      title: PagedMembershipOfferings
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MembershipOffering'
        page:
          $ref: '#/components/schemas/PageCursor'
      required:
        - data
        - page
      additionalProperties: false
    MembershipOffering:
      title: MembershipOffering
      type: object
      properties:
        id:
          type: string
        schemeId:
          type: string
        tier:
          type: object
          properties:
            id:
              type: string
            title:
              type: string
            description:
              type: string
          required:
            - id
            - title
          additionalProperties: false
        plan:
          type: object
          properties:
            id:
              type: string
            title:
              type: string
            description:
              type: string
            numberOfAdults:
              type: number
            numberOfChildren:
              type: number
            maxChildAge:
              type: number
            maxTotalMembers:
              type: number
            primaryMemberType:
              type: string
          required:
            - id
            - title
            - numberOfAdults
            - numberOfChildren
            - maxChildAge
            - maxTotalMembers
            - primaryMemberType
          additionalProperties: false
        currentPrice:
          $ref: '#/components/schemas/MembershipPrice'
        benefitsMarkdown:
          type: string
        benefits:
          type: array
          items:
            $ref: '#/components/schemas/MembershipOfferingBenefit'
      required:
        - id
        - schemeId
        - tier
        - plan
        - currentPrice
        - benefits
      additionalProperties: false
      description: Self-contained current offer for a change-plan screen.
    PageCursor:
      title: PageCursor
      type: object
      properties:
        totalResults:
          type: number
          description: The total number of results available.
        first:
          type: string
          description: The cursor for the first page of results.
        last:
          type: string
          description: The cursor for the last page of results.
        prev:
          type: string
          description: The cursor for the previous page of results.
        next:
          type: string
          description: The cursor for the next page of results.
      required:
        - totalResults
        - first
        - last
        - prev
        - next
      additionalProperties: false
      description: >-
        **Cursor details for pagination**.

        - In scenarios with large amounts of data, it's common to return only a
        subset of data in a single request, known as a "page".

        - Most API responses include two objects: a 'data' object with the query
        results, and a 'PageCursor' object detailing the current page.

        - Cursors can be used to navigate to earlier or later pages in the set
        of results. For instance, passing the 'next' cursor from 'PageCursor'
        fetches the next set of results.

        - Cursors are base64 encoded strings.
      example:
        totalResults: 506
        first: >-
          eyJpZCI6IjYzOTljMjAwMTVkNjBhZTNmZjI4ZjI0YyIsInVwZGF0ZWRBdCI6IjIwMjItMTItMTRUMTI6MzA6NTkuMjE3WiJ9
        last: >-
          eyJpZCI6IjY1NGNkZDIxZDlhMTU3ODdiNzFkMTM0YSIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNzI0WiJ9
        prev: ''
        next: >-
          eyJpZCI6IjY0NzBkNTkwM2RjOWE5OWJhMTA0Y2ZhYiIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNjE4WiJ9
    MembershipPrice:
      title: MembershipPrice
      type: object
      properties:
        id:
          type: string
          description: Public offering-price revision id, also pinned on a member's policy.
        offeringId:
          type: string
        isCurrent:
          type: boolean
          description: >-
            On sale to new members now; does not describe an existing member's
            price.
        createdAt:
          type: string
        retiredAt:
          type: string
        purchaseType:
          type: string
          enum:
            - ONE_TIME
            - SUBSCRIPTION
        amount:
          anyOf:
            - $ref: '#/components/schemas/MembershipMoney'
            - type: 'null'
          description: >-
            Null when a legacy price's configuration is unavailable, never
            interpreted as free.
        fee:
          anyOf:
            - $ref: '#/components/schemas/MembershipMoney'
            - type: 'null'
        billingInterval:
          type:
            - string
            - 'null'
          enum:
            - day
            - week
            - month
            - year
            - null
          description: >-
            How often a subscription renews, with billingIntervalCount; null for
            a one-time price or an unavailable configuration.
        billingIntervalCount:
          type:
            - number
            - 'null'
          description: >-
            How many billingInterval units one billing cycle spans, e.g. 3 with
            month for quarterly.
        detailsAvailable:
          type: boolean
      required:
        - id
        - offeringId
        - isCurrent
        - createdAt
        - purchaseType
        - amount
        - fee
        - billingInterval
        - billingIntervalCount
        - detailsAvailable
      additionalProperties: false
    MembershipOfferingBenefit:
      title: MembershipOfferingBenefit
      type: object
      properties:
        title:
          type: string
        type:
          type: string
          enum:
            - PRICE_ADJUSTMENT
            - GUEST_PASS
        adjustmentType:
          type: string
          enum:
            - ABSOLUTE_PRICE
            - ABSOLUTE_DISCOUNT
            - PERCENTAGE_DISCOUNT
        amount:
          $ref: '#/components/schemas/MembershipMoney'
        percentage:
          type: number
        maxUses:
          type: number
        discountAppliesToBookingFee:
          type: boolean
        resetsOnRenewal:
          type: boolean
        restrictions:
          type: object
          properties:
            eventIds:
              type: array
              items:
                type: string
            eventOccurrenceIds:
              type: array
              items:
                type: string
            raceIds:
              type: array
              items:
                type: string
            ticketSlugs:
              type: array
              items:
                type: string
            bookingItemIds:
              type: array
              items:
                type: string
          additionalProperties: false
      required:
        - title
        - type
        - restrictions
      additionalProperties: false
    MembershipMoney:
      title: MembershipMoney
      type: object
      properties:
        value:
          type: number
        currencyCode:
          type: string
      required:
        - value
        - currencyCode
      additionalProperties: false
      description: Money in minor units, e.g. DKK 150 is value 15000.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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