> ## 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 the offerings a policy could change to

> Lists the other offerings this policy could move to. Each one says whether the change is allowed, whether it's an upgrade, downgrade or swap, when it could take effect and what would be due now.

## How to use it

- With a member token, only the primary member can ask, and the scheme's member rules and notice period apply.
- With an organizer key, member rules don't apply and nothing is ever due.
- Offerings the policy could never move to are left out.
- Pass `releaseSeatIds`, comma-separated, to quote as if those secondary seats end when the change takes effect.

> [!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-policies/{policyId}/offering-change-options
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-policies/{policyId}/offering-change-options:
    get:
      tags:
        - Membership
      summary: List the offerings a policy could change to
      description: >-
        Lists the other offerings this policy could move to. Each one says
        whether the change is allowed, whether it's an upgrade, downgrade or
        swap, when it could take effect and what would be due now.


        ## How to use it


        - With a member token, only the primary member can ask, and the scheme's
        member rules and notice period apply.

        - With an organizer key, member rules don't apply and nothing is ever
        due.

        - Offerings the policy could never move to are left out.

        - Pass `releaseSeatIds`, comma-separated, to quote as if those secondary
        seats end when the change takes effect.
      parameters:
        - schema:
            type: string
          in: query
          name: releaseSeatIds
          required: false
          description: >-
            Secondary seat ids, comma-separated. Each offering is quoted as if
            these seats end when the change takes effect.
        - schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
          in: path
          name: policyId
          required: true
          description: >-
            The id of a membership policy: a member's purchased membership. Each
            seat names its policy in `policyId`.
      responses:
        '200':
          description: >-
            The offerings the policy could move to, each saying whether the
            change is allowed and what it would cost.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MembershipOfferingChangeOptions'
        '400':
          description: A query parameter is missing or malformed. `message` says which.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - statusCode
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - MEMBERSHIP_INVALID_REQUEST
                  statusCode:
                    type: integer
                    enum:
                      - 400
                  message:
                    type: string
        '404':
          description: Your organization has no membership policy 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
        '503':
          description: Offering changes are switched off for now. Retry later.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - statusCode
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - MEMBERSHIP_OFFERING_CHANGES_UNAVAILABLE
                  statusCode:
                    type: integer
                    enum:
                      - 503
                  message:
                    type: string
components:
  schemas:
    MembershipOfferingChangeOptions:
      title: MembershipOfferingChangeOptions
      type: object
      properties:
        options:
          type: array
          items:
            $ref: '#/components/schemas/MembershipOfferingChangeOption'
      required:
        - options
      additionalProperties: false
      description: >-
        The scheme's other offerings the policy could move to, each quoted for
        the caller.
    MembershipOfferingChangeOption:
      title: MembershipOfferingChangeOption
      type: object
      properties:
        offeringId:
          type: string
        tierTitle:
          type:
            - string
            - 'null'
        planTitle:
          type:
            - string
            - 'null'
        price:
          anyOf:
            - $ref: '#/components/schemas/MembershipOfferingChangeCyclePrice'
            - type: 'null'
          description: What it costs each cycle, as a renewal on it would bill.
        currentPrice:
          anyOf:
            - $ref: '#/components/schemas/MembershipOfferingChangeCyclePrice'
            - type: 'null'
          description: What the policy is billed each cycle now.
        eligible:
          type: boolean
          description: Whether the caller may move the policy onto this offering.
        refusals:
          type: array
          items:
            $ref: '#/components/schemas/MembershipOfferingChangeRefusal'
        direction:
          type:
            - string
            - 'null'
          description: UPGRADE, DOWNGRADE or SWAP when eligible.
        timingOptions:
          type: array
          items:
            $ref: '#/components/schemas/MembershipOfferingChangeTimingOption'
      required:
        - offeringId
        - tierTitle
        - planTitle
        - price
        - currentPrice
        - eligible
        - refusals
        - direction
        - timingOptions
      additionalProperties: false
    MembershipOfferingChangeCyclePrice:
      title: MembershipOfferingChangeCyclePrice
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/MembershipMoney'
        intervalUnit:
          type:
            - string
            - 'null'
          description: day, week, month or year; null for a one-time price.
        intervalCount:
          type:
            - number
            - 'null'
      required:
        - amount
        - intervalUnit
        - intervalCount
      additionalProperties: false
      description: What a membership costs each cycle on an offering, booking fee included.
    MembershipOfferingChangeRefusal:
      title: MembershipOfferingChangeRefusal
      type: object
      properties:
        reason:
          type: string
          description: >-
            Such as NOT_PRIMARY_MEMBER, RULE_FORBIDS, SEATS_EXCEED_TARGET,
            PAYMENT_IN_PROGRESS or CANCELLATION_PENDING. More may be added.
        details:
          type: object
          additionalProperties:
            type: string
          description: What the reason carries, such as the scheme rule it broke.
      required:
        - reason
        - details
      additionalProperties: false
      description: Why the policy can't move to an offering.
    MembershipOfferingChangeTimingOption:
      title: MembershipOfferingChangeTimingOption
      type: object
      properties:
        timing:
          type: string
          enum:
            - NOW
            - AT_RENEWAL
        notBefore:
          type:
            - string
            - 'null'
          description: 'For AT_RENEWAL: send this as notBefore to land on effectiveAt.'
          format: date-time
        effectiveAt:
          type: string
          format: date-time
        amountDueNow:
          anyOf:
            - $ref: '#/components/schemas/MembershipMoney'
            - type: 'null'
          description: >-
            What the member pays before a change made now applies; null when
            nothing is due.
      required:
        - timing
        - notBefore
        - effectiveAt
        - amountDueNow
      additionalProperties: false
      description: When a change to an offering could take effect, and what it costs now.
    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.