> ## 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 policy's pending change

> Returns the policy's pending change, if any: an offering change waiting for its renewal or its payment, or a cancellation.

`pendingChange` is `null` when nothing is pending. With a member token, only the primary member can read it.

> [!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}/pending-change
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}/pending-change:
    get:
      tags:
        - Membership
      summary: Get a policy's pending change
      description: >-
        Returns the policy's pending change, if any: an offering change waiting
        for its renewal or its payment, or a cancellation.


        `pendingChange` is `null` when nothing is pending. With a member token,
        only the primary member can read it.
      parameters:
        - 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 pending change, or `null` in `pendingChange` when nothing is
            pending.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MembershipPolicyPendingChange'
        '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
components:
  schemas:
    MembershipPolicyPendingChange:
      title: MembershipPolicyPendingChange
      type: object
      properties:
        pendingChange:
          anyOf:
            - type: object
              properties:
                id:
                  type: string
                kind:
                  type: string
                  enum:
                    - OFFERING
                    - CANCELLATION
                  description: >-
                    OFFERING: a move to another offering. CANCELLATION: the
                    policy ends.
                timing:
                  type: string
                  enum:
                    - NOW
                    - AT_RENEWAL
                    - AT_DATE
                  description: >-
                    AT_DATE is a cancellation once its notice period has passed,
                    mid-cycle or not.
                effectiveAt:
                  type: string
                  format: date-time
                requestedAt:
                  type: string
                  format: date-time
                requestedByKind:
                  type:
                    - string
                    - 'null'
                  description: MEMBER, ORGANIZER, LDT or SYSTEM; null when not recorded.
                requestedVia:
                  type: string
                  description: DASHBOARD, SUPPORT_AGENT, PUBLIC_API, INTERNAL or BACKFILL.
                cancellationCause:
                  type:
                    - string
                    - 'null'
                  description: >-
                    For a cancellation, why it was made. NON_PAYMENT: a renewal
                    went unpaid; paying it calls the cancellation off.
                    BY_REQUEST: the member or the organizer asked for it. More
                    may be added. Null for an offering change.
                toOfferingId:
                  type:
                    - string
                    - 'null'
                  description: For an offering change; null for a cancellation.
                direction:
                  type:
                    - string
                    - 'null'
                  description: >-
                    UPGRADE, DOWNGRADE or SWAP for an offering change; null for
                    a cancellation.
                amountDueNow:
                  anyOf:
                    - $ref: '#/components/schemas/MembershipMoney'
                    - type: 'null'
                  description: >-
                    Still due before an offering change made now applies; null
                    once paid or when nothing is.
                payBy:
                  type:
                    - string
                    - 'null'
                  description: Unpaid by then, the offering change fails.
                  format: date-time
                releaseSeatIds:
                  type: array
                  items:
                    type: string
                  description: >-
                    Secondary seats that end when an offering change takes
                    effect.
              required:
                - id
                - kind
                - timing
                - effectiveAt
                - requestedAt
                - requestedByKind
                - requestedVia
                - cancellationCause
                - toOfferingId
                - direction
                - amountDueNow
                - payBy
                - releaseSeatIds
              additionalProperties: false
            - type: 'null'
          description: Null when nothing is pending.
      required:
        - pendingChange
      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.