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

# Update a membership credit

> Return (recredit) or reclaim a membership credit on a rental. Set status to `returned` to credit the customer back, or `unreturned` to reclaim a previously returned credit.



## OpenAPI

````yaml https://app.supercycle.com/docs/openapi-v1.yml put /membership_credits/{membershipCreditId}
openapi: 3.1.0
info:
  title: Supercycle API
  version: 1.0.0
  contact:
    name: Supercycle Support
    email: support@supercycle.com
  description: >+
    The Supercycle API provides comprehensive endpoints designed to streamline
    inventory, rental, and return management for merchants using the Supercycle
    platform. This API facilitates the integration with external systems such as
    Shopify, enabling seamless synchronization of product data, rental
    operations, and returns processing.

    Key features include: - **Inventory Management:** Endpoints to create,
    update, and retrieve detailed information about items and products. -
    **Rental Operations:** Manage rentals from creation to dispatch, with
    automated serial allocation and synchronization with Shopify orders. -
    **Returns Processing:** Efficiently manage and track returns with the
    ability to update statuses and item conditions. - **Timeline Comments:** Add
    comments to timeline events associated with resources in a shop. -
    **Availability Timelines:** Per-variant day-by-day availability counts for
    back-office and OMS integrations (mirrors the storefront availability
    timeline). - **Blocked Dates:** List, retrieve, and create manually blocked
    date ranges on items, variants, and products that reduce availability.

    **Rate limits:** Requests are throttled per API key (Bearer token). Across
    all endpoints, a key may make at most **120 requests per minute**. The
    availability timeline endpoint (`GET /availability_timelines`) is limited to
    **10 requests per minute** per key because it is computationally
    expensive—cache responses client-side where possible. Requests without a
    Bearer token are limited to **30 requests per minute** per client IP. When
    exceeded, the API returns **429 Too Many Requests** with `Retry-After`,
    `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset`
    headers.

    This API is essential for merchants looking to enhance their operational
    efficiency, providing the tools needed to manage their inventory, rentals,
    returns, timeline events, availability planning, and blocked dates all in
    one place.

    For support or enquiries, please contact [Supercycle
    Support](mailto:support@supercycle.com).

servers:
  - url: https://app.supercycle.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: AvailabilityTimelines
  - name: BlockedDates
  - name: Conditions
  - name: CustomFieldDefinitions
  - name: CustomFields
  - name: Items
  - name: Products
  - name: Variants
  - name: Rentals
  - name: ReturnOrders
  - name: TimelineComments
  - name: Locations
paths:
  /membership_credits/{membershipCreditId}:
    parameters:
      - $ref: '#/components/parameters/MembershipCreditId'
    put:
      tags:
        - Rentals
      summary: Update a membership credit
      description: >-
        Return (recredit) or reclaim a membership credit on a rental. Set status
        to `returned` to credit the customer back, or `unreturned` to reclaim a
        previously returned credit.
      operationId: putMembershipCredit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MembershipCreditUpdate'
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MembershipCredit'
        '404':
          description: Membership credit not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    MembershipCreditId:
      in: path
      name: membershipCreditId
      schema:
        type: integer
      required: true
      description: Numeric ID of the membership credit to update.
  schemas:
    MembershipCreditUpdate:
      type: object
      required:
        - membershipCredit
      properties:
        membershipCredit:
          type: object
          required:
            - status
          properties:
            status:
              type: string
              enum:
                - unreturned
                - returned
              description: >-
                Set to `returned` to recredit the customer, or `unreturned` to
                reclaim the credit.
    MembershipCredit:
      type: object
      required:
        - id
        - creditCost
        - status
      properties:
        id:
          type: integer
          format: int64
          description: Numeric ID of the membership credit.
        creditCost:
          type: integer
          description: Number of credits this rental costs the customer's membership.
        status:
          type: string
          enum:
            - unreturned
            - returned
          description: Whether the credit has been returned to the customer's membership.
        returnCondition:
          oneOf:
            - type: 'null'
            - type: string
              enum:
                - return_order_created
                - received_at
          description: >-
            When the credit is automatically returned, if configured on the
            shop.
  responses:
    UnprocessableEntity:
      description: Invalid request
      content:
        application/json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  type: string
                  example: Invalid request body
    TooManyRequests:
      description: Rate limit exceeded
      headers:
        Retry-After:
          description: Seconds until the current throttle window resets.
          schema:
            type: integer
            example: 42
        X-RateLimit-Limit:
          description: Maximum requests allowed in the window that triggered this response.
          schema:
            type: integer
            example: 120
        X-RateLimit-Remaining:
          description: >-
            Remaining requests in the window (always 0 when this response is
            returned).
          schema:
            type: integer
            example: 0
        X-RateLimit-Reset:
          description: ISO 8601 timestamp when the throttle window resets.
          schema:
            type: string
            format: date-time
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: string
                example: Rate limit exceeded. Retry after 42 seconds.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````