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

# Charge a charge to the member's saved card

> Charges what a charge still owes to the member's saved card, taken from the account of the company the charge belongs to (a guardian's card pays a dependent's charge). The charge is merchant-initiated, with nobody present to authenticate, so a card that needs 3D Secure is declined with `authentication_required`. A same-day retry for the same amount and card is not charged twice. A card the bank refuses is an answer, not an error: `payment.status` is `failed` with Stripe's reason in `payment.failureCode`, such as `insufficient_funds`, `expired_card` or `authentication_required`. A payment Stripe has not finished, or one it could not confirm either way (the card may have been charged), is `pending` (or `processing`), never `failed`: do not take the money another way until it settles. While it is pending, recording a payment for the charge is refused with `409 PAYMENT_IN_PROGRESS`, however long Stripe takes to answer. A charge that owes nothing is refused with `409 CHARGE_NOT_OWED`, one with a payment already pending or processing with `409 PAYMENT_IN_PROGRESS`, a member with no saved card with `409 NO_SAVED_CARD`, and a charge with no contact with `400 CHARGE_HAS_NO_CONTACT`. An API key reaches only the charges of bookings it made through the API; any other charge is a 404.




## OpenAPI

````yaml /openapi-platform.json post /v1/platform/transactions/{id}/charge-saved-card
openapi: 3.0.0
info:
  title: 1club Platform API
  version: 1.0.0
  description: >-
    The 1club Platform API lets you programmatically access and manage your
    organization's data.


    ## Official API Contract


    This documentation is the official source of truth for the 1club Platform
    API.

    If an integration relies on undocumented endpoints, fields, response shapes,
    or internal behavior outside this spec, we can't guarantee backward
    compatibility.

    Build against what's documented here to stay stable as the platform evolves.


    ## Authentication


    All requests require a customer API key passed as a Bearer token:


    ```

    Authorization: Bearer 1club_sk_live_...

    ```


    Generate API keys from the admin portal under **Settings > API Tokens**.

    The key is tied to your organization - all responses are scoped to your
    org's data.


    Agents and MCP connectors can instead send an OAuth access token (the
    `platformOAuth` scheme), requesting only the scopes the task needs.


    ## Rate Limiting


    - **100 requests per minute** per API key

    - When exceeded, the API returns `429 Too Many Requests` with a
    `Retry-After` header

    - Rate limit headers are included in every response:
      - `X-RateLimit-Limit` - max requests per window
      - `X-RateLimit-Remaining` - requests remaining
      - `X-RateLimit-Reset` - seconds until the window resets

    ## Errors


    | Status | Meaning |

    |--------|---------|

    | `400` | Invalid request parameters |

    | `401` | Missing or invalid API key |

    | `404` | Resource not found (or doesn't belong to your organization) |

    | `429` | Rate limit exceeded |

    | `500` | Internal server error |


    ## Versioning and deprecation


    The API is versioned in the path (`/v1`). Changes within a version are
    additive: new endpoints, new optional parameters and new response fields can
    appear at any time, so clients should ignore fields they do not recognise.

    A breaking change ships as a new version.

    An operation due to be removed is first marked `deprecated: true` in this
    spec and announced in the changelog at https://docs.1club.ai/changelog, with
    advance notice before it is withdrawn.
  contact:
    name: 1club API Support
    email: support@1club.ai
servers:
  - url: https://api.1club.ai
    description: Production API
security:
  - customerApiAuth: []
  - platformOAuth: []
tags: []
paths:
  /v1/platform/transactions/{id}/charge-saved-card:
    post:
      tags:
        - Transactions
      summary: Charge a charge to the member's saved card
      description: >
        Charges what a charge still owes to the member's saved card, taken from
        the account of the company the charge belongs to (a guardian's card pays
        a dependent's charge). The charge is merchant-initiated, with nobody
        present to authenticate, so a card that needs 3D Secure is declined with
        `authentication_required`. A same-day retry for the same amount and card
        is not charged twice. A card the bank refuses is an answer, not an
        error: `payment.status` is `failed` with Stripe's reason in
        `payment.failureCode`, such as `insufficient_funds`, `expired_card` or
        `authentication_required`. A payment Stripe has not finished, or one it
        could not confirm either way (the card may have been charged), is
        `pending` (or `processing`), never `failed`: do not take the money
        another way until it settles. While it is pending, recording a payment
        for the charge is refused with `409 PAYMENT_IN_PROGRESS`, however long
        Stripe takes to answer. A charge that owes nothing is refused with `409
        CHARGE_NOT_OWED`, one with a payment already pending or processing with
        `409 PAYMENT_IN_PROGRESS`, a member with no saved card with `409
        NO_SAVED_CARD`, and a charge with no contact with `400
        CHARGE_HAS_NO_CONTACT`. An API key reaches only the charges of bookings
        it made through the API; any other charge is a 404.
      operationId: chargeSavedCard
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: The charge after the attempt, with how the payment went
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PlatformTransaction'
                  - type: object
                    required:
                      - outstanding
                      - payment
                    properties:
                      outstanding:
                        type: number
                        description: What the charge still owes, tax included
                      payment:
                        type: object
                        required:
                          - id
                          - status
                          - failureCode
                        properties:
                          id:
                            type: integer
                            nullable: true
                            description: >-
                              The payment recorded; null when the card was
                              refused
                          status:
                            type: string
                            enum:
                              - succeeded
                              - processing
                              - pending
                              - failed
                          failureCode:
                            type: string
                            nullable: true
                            description: >-
                              Stripe's decline code, or its error code, when
                              `status` is `failed`
        '400':
          description: Invalid transaction ID, or a charge with no contact
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '401':
          $ref: '#/components/responses/PlatformUnauthorized'
        '403':
          description: API key is missing the required `payments:write` scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '404':
          description: Transaction not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '409':
          description: >-
            The charge owes nothing, a payment for it is already pending or
            processing, or the member has no saved card
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '429':
          $ref: '#/components/responses/PlatformRateLimited'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformTransaction:
      type: object
      description: >-
        A billing transaction with amounts, payment status, and links to the
        originating booking or membership.
      properties:
        id:
          type: integer
        uuid:
          type: string
          format: uuid
          description: >-
            Stable unguessable identifier. Prefer this over `id` when storing a
            reference.
        description:
          type: string
          nullable: true
          description: >-
            What the transaction is for, in English, built from what it links
            to: the part of the booking it pays for and the visit, the plan and
            the period it pays for, the product or the check-in; a reversal
            reads `Reversal: ...` with the share it gives back. For a
            settlement, or anything else linked to none of those, it is the text
            it was created with. Read it as a label, not as an identifier: it
            follows the records' current names.
        transactionType:
          type: string
          nullable: true
          description: >-
            TransactionType enum value (e.g. booking_creation,
            membership_creation, product_sale, membership_recurrence, etc.). A
            settlement recorded with `POST /v1/platform/transactions` is
            `settlement`.
        bookingId:
          type: integer
          nullable: true
        membershipId:
          type: integer
          nullable: true
        contactId:
          type: integer
          nullable: true
          description: The customer charged, when there is one.
        clubId:
          type: integer
          nullable: true
          description: >-
            Set on a settlement only; other transactions take their club from
            their booking or membership.
        createdAt:
          type: string
          format: date-time
        date:
          type: string
          format: date-time
          description: >-
            The day the charge counts on in every money report: when it was
            sold, a booking's visit, or the start of the membership period it
            pays for.
        dueDate:
          type: string
          format: date-time
          nullable: true
          description: >-
            The day an unpaid charge falls due (midnight UTC naming the calendar
            day), set only where that is later than `date`: a Season Pass sold
            ahead is dated at its sale and owed from the day it starts. Null
            means it is due on `date`.
        paymentStatus:
          type: string
          enum:
            - pending
            - paid
            - void
            - failed
            - settled
            - overdue
            - partially_paid
            - refunded
            - cancelled
        amount:
          type: string
          description: >-
            Pre-tax amount as a decimal string (e.g. "25.00"). Serialized as a
            string to preserve precision.
        taxAmount:
          type: string
          description: Tax portion as a decimal string.
        totalAmount:
          type: string
          description: Total billed amount as a decimal string (amount + taxAmount).
    PlatformError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: >-
            A stable, machine-readable reason, when the error has one (e.g.
            `CONTACT_EXISTS`).
        details:
          type: object
          additionalProperties: true
          description: >-
            Structured values behind the error. A 409 naming an existing record
            carries its id here, e.g. `contactId`.
  responses:
    PlatformUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
  securitySchemes:
    customerApiAuth:
      type: http
      scheme: bearer
      description: >-
        Organization-scoped bearer credential: a customer API key
        (1club_sk_live_...) or an MCP OAuth access token.
    platformOAuth:
      type: oauth2
      description: >-
        OAuth 2.1 authorization code flow with PKCE (S256), as used by MCP
        connectors. Register a client dynamically (RFC 7591) at
        https://api.1club.ai/v1/mcp/oauth/register. Each scope grants one
        capability; request only what the integration needs.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.1club.ai/oauth/authorize
          tokenUrl: https://api.1club.ai/v1/mcp/oauth/token
          scopes:
            '*': >-
              Full access - read and manage everything in this organization,
              including capabilities added later
            classes:read: View classes, class types, schedules and progression tracks
            classes:write: >-
              Create, reschedule, and cancel classes, and maintain the class
              types they are run as
            checkins:read: View check-ins
            checkins:write: Check people in, to a booking or on their membership
            content:read: View published content
            content:write: >-
              Create, edit and delete content - posts, FAQs, documents and
              reusable blocks
            website:read: >-
              View your website: pages, sections, layout, styles and publish
              history
            website:write: >-
              Edit your website - pages, sections, navigation and styles. Edits
              stay unpublished until published.
            website:publish: >-
              Publish your website, making unpublished edits visible to the
              public, and roll back to an earlier version
            media:read: View your media library
            media:write: >-
              Add images and videos to your media library and edit their names
              and descriptions
            media:delete: Permanently delete files from your media library
            clubs:read: View club information
            clubs:write: >-
              Edit your clubs' details - name, contact details, address, opening
              hours, amenities and sports. Live on your website, member portal,
              app and 1club.me at once; a club listed on 1club.me sends its
              listing's changes for review.
            transactions:read: >-
              View transactions, who owes you and for how long, the sales behind
              your tax report and your chart of accounts
            transactions:write: >-
              Record revenue collected outside 1club, such as a marketplace
              payout for your bookings, and refunds of it. Nothing is charged to
              anyone.
            transactions:delete: >-
              Void unpaid charges so they are no longer owed, and delete ones
              raised by mistake. A never-paid pass whose last charge goes is
              cancelled with it. Paid charges cannot be voided or deleted, and
              an API key reaches only the charges of bookings it made.
            payments:write: >-
              Record a payment against what a member owes, with one of your own
              payment methods such as cash or a bank transfer, and charge a
              member's saved card for a charge. An API key reaches only the
              charges of bookings it made.
            invoices:read: >-
              View your invoices - who they were issued to, their amounts and
              status - and how much was invoiced over a period
            areas:read: View areas, area types, blocks and availability
            areas:write: >-
              Create and update areas and area types, and block or unblock an
              area
            bookings:read: >-
              View bookings, and every booking of a period with where its
              payment stands (the booking audit)
            bookings:write: >-
              Create, change, reschedule and cancel bookings, add or remove
              participants, and waive what a cancelled or missed booking still
              owes
            bookings:delete: >-
              Permanently delete bookings entered by mistake, with their unpaid
              charges, check-ins and players. A paid or invoiced booking cannot
              be deleted - cancel and refund it instead.
            contacts:read: >-
              View contacts, their tags and custom field values, and your sales
              pipeline stages and sources, and who is behind your people reports
              (at risk, renewals, promotions, cancellations)
            contacts:write: >-
              Create and update contacts and tag them, and maintain your tags,
              smart tag rules and contact custom fields
            contacts:delete: >-
              Archive contacts, which cancels their active memberships and all
              their future bookings. Separate from creating and updating because
              those cancellations are not undone by restoring the contact.
            instructors:read: >-
              View instructors, their availability, the staff roster and their
              time off
            instructors:write: >-
              Create and update instructors (coaches) and the instructor types
              they are grouped by, including what members pay for a one-to-one
              session and how you pay the coach, and manage the staff roster
              (shifts, rotations) and their time off. Does not grant
              admin-portal access: an instructor created this way has no login
              and is never invited to your staff portal.
            plans:read: View plans and pricing
            plans:write: Create, edit and delete plans and plan categories
            memberships:read: View memberships
            memberships:write: >-
              Sell memberships, set their price and whether they are paid, and
              pause, resume or cancel them
            products:read: >-
              View the product catalogue and its categories, including prices
              and how many are left to sell
            products:write: Create and edit products and product categories
            forms:read: >-
              View your forms and their questions, and how many people have
              completed each. Not the answers themselves.
            forms:write: >-
              Create and edit forms and their questions, including sign-up forms
              that sell your plans and products. Forms are public as soon as
              they are created or changed. Does not delete forms.
            organization:write: >-
              Change organization-wide settings, which take effect immediately.
              That includes which languages you offer, across your website, the
              member portal, the mobile app and email, and what your clubs call
              their booking cards (private training, group activities, areas)
              wherever members book.
            revenue-accounts:write: >-
              Add accounts to your chart of accounts and edit them, including
              which one sales post to by default. Reading the chart needs no
              scope of its own - any of plans, products or transactions admits
              it.
            pricing-rules:read: >-
              View pricing rules - the surcharges, discounts and set prices
              applied when a booking is priced - and quote what a booking would
              cost
            pricing-rules:write: >-
              Create, edit, turn off and delete pricing rules. Changes apply to
              every booking priced afterwards.
            booking-policies:read: >-
              View booking policies: cancellation and refund rules, payment
              timing and booking windows
            booking-policies:write: >-
              Create, edit, duplicate and delete booking policies. Changes apply
              to every booking they cover from then on.
            document-rules:read: >-
              View document rules - which members are asked to sign or accept
              which documents, such as waivers
            document-rules:write: >-
              Create, edit and delete document rules, which decide who must sign
              or accept a document and whether it is required for entry
            external-programs:read: >-
              View external programs - third parties such as MultiSport or a
              corporate wellness scheme that pay for members' visits - and what
              each covers
            external-programs:write: >-
              Create, edit and remove external programs, including what each
              pays per visit and which classes, areas and coaches it can be used
              for
            templates:read: View your email and SMS templates
            templates:write: Create, edit and delete email and SMS templates
            events:read: View events, their tickets and how many are sold
            events:write: >-
              Create, edit, duplicate and delete events, and publish, unpublish
              or cancel them. Cancelling an event also cancels its attendees'
              bookings.
            messages:read: >-
              View messages sent to and received from your members, and their
              delivery status
            messages:write: >-
              Prepare draft messages to members. Drafts are never sent from
              here: someone at your club reviews and sends them from 1club.
            analytics:read: >-
              View statistics over a period - revenue, tax, bookings, check-ins,
              how full your classes, courts and coaches were, memberships added
              and cancelled, and new members - as totals, never the people or
              sales behind them
            payment-methods:write: >-
              Add, rename and remove the payment methods staff record by hand,
              such as cash or a bank transfer, and choose which ones members may
              pick when paying for a booking. Reading them needs no scope of its
              own - transactions:read admits it.
            staff:read: >-
              View your staff accounts, their roles, and what each role is
              allowed to do
            staff:write: >-
              Change a staff member's role, and what the manager, front desk and
              instructor roles are allowed to do. Only a signed-in person can
              use it, with the same limits as in 1club: an API key is always
              refused.
            notifications:read: >-
              View which notifications each role gets by default, and on which
              channels
            notifications:write: >-
              Change which notifications each role gets and on which channels,
              and apply those defaults to everyone in a role, replacing their
              own choices
            competitors:read: >-
              View the competitors you follow, their prices and Google ratings,
              and how your prices compare with the market
            competitors:write: >-
              Add, edit and remove the competitors you follow, and have their
              websites read again
            promotions:read: >-
              View your promotions - discounts and vouchers, their promo codes,
              dates and how often they were redeemed
            promotions:write: >-
              Create, edit and delete promotions - discounts and vouchers and
              their promo codes. A promotion is offered to members as soon as
              its dates allow.
            reviews:read: >-
              View your reviews - ratings, what members wrote, your replies and
              the private notes reviewers left for you
            automations:read: >-
              View your automations - what starts each one, its steps and the
              messages it sends

````

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