Records that the member paid what a charge still owes, with one of your organization’s own payment methods - money already taken at the desk, such as cash, a card on your own terminal or a bank transfer. The whole outstanding is recorded, the charge becomes paid and the member is sent a receipt. Nothing is charged: to take the money from a member’s saved card, use charge-saved-card. A method that takes the money itself (Stripe, the Wallet) is refused with 400 TENDER_NOT_RECORDABLE, a charge that owes nothing (or no longer owes what was read, because another payment landed first) with 409 CHARGE_NOT_OWED, one with no contact with 400 CHARGE_HAS_NO_CONTACT, and one a payment is already being taken for, such as a saved card being charged or one whose outcome Stripe has not confirmed, with 409 PAYMENT_IN_PROGRESS: wait for that payment to settle. An API key reaches only the charges of bookings it made through the API; any other charge is a 404.
TransactionType enum value (e.g. booking_creation, membership_creation, product_sale, membership_recurrence, etc.). A settlement recorded with POST /v1/platform/transactions is settlement.
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.
Total billed amount as a decimal string (amount + taxAmount).
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"1club Help","colors":{"primary":"#471EFF","light":"#FFFFFF","dark":"#000000"},"logo":{"light":"https://mintcdn.com/1club/HM7mOd-FIJUyvW_1/logo/light.svg?fit=max\u0026auto=format\u0026n=HM7mOd-FIJUyvW_1\u0026q=85\u0026s=d93b7eb86d0fd304bfe27889e979db38","dark":"https://mintcdn.com/1club/HM7mOd-FIJUyvW_1/logo/dark.svg?fit=max\u0026auto=format\u0026n=HM7mOd-FIJUyvW_1\u0026q=85\u0026s=735ee613692e24e029e7d087b7effd44"},"favicon":"https://mintcdn.com/1club/iwVNuiPtdtxB6zsm/icon.png?fit=max\u0026auto=format\u0026n=iwVNuiPtdtxB6zsm\u0026q=85\u0026s=c8230ff0ac00066a07d7b0067f4c3df2","api":{"playground":{"display":"interactive","proxy":true}},"navbar":{"links":[{"href":"mailto:support@1club.ai","label":"Support"},{"href":"https://1club.ai","label":"Website"}],"primary":{"type":"button","label":"Log in","href":"https://admin.1club.ai"}},"footer":{"socials":{"x":"https://x.com/1club_ai","linkedin":"https://linkedin.com/company/1club_ai"}},"search":{"prompt":"Search the 1club help center"},"seo":{"metatags":{"og:type":"website","og:site_name":"1club Help","twitter:card":"summary_large_image"},"indexing":"all"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"1club","hasAudioNarration":false,"actualSubdomain":"1club","customDomains":["docs.1club.ai"],"gitSource":{"type":"github","owner":"1club-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af17c8636ccab500109674e","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API","count":296},{"language":"default","tag":"Settings","count":118},{"language":"default","tag":"Guides","count":71},{"language":"default","tag":"Admin","count":63},{"language":"default","tag":"Staff Roster","count":24},{"language":"default","tag":"Website","count":21},{"language":"default","tag":"Classes","count":20},{"language":"default","tag":"Sales","count":19},{"language":"default","tag":"Events","count":15},{"language":"default","tag":"Members","count":15}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/transactions/record-a-payment-for-a-charge","slug":"/api-reference/transactions/record-a-payment-for-a-charge","pageMetadata":{"title":"Record a payment for a charge","description":"Records that the member paid what a charge still owes, with one of your organization's own payment methods - money already taken at the desk, such as cash, a card on your own terminal or a bank transfer. The whole outstanding is recorded, the charge becomes `paid` and the member is sent a receipt. Nothing is charged: to take the money from a member's saved card, use `charge-saved-card`. A method that takes the money itself (Stripe, the Wallet) is refused with `400 TENDER_NOT_RECORDABLE`, a charge that owes nothing (or no longer owes what was read, because another payment landed first) with `409 CHARGE_NOT_OWED`, one with no contact with `400 CHARGE_HAS_NO_CONTACT`, and one a payment is already being taken for, such as a saved card being charged or one whose outcome Stripe has not confirmed, with `409 PAYMENT_IN_PROGRESS`: wait for that payment to settle. An API key reaches only the charges of bookings it made through the API; any other charge is a 404.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/record-payment","href":"/api-reference/transactions/record-a-payment-for-a-charge","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Records that the member paid what a charge still owes, with one of your organization’s own payment methods - money already taken at the desk, such as cash, a card on your own terminal or a bank transfer. The whole outstanding is recorded, the charge becomes \", _jsx(_components.code, {\n children: \"paid\"\n }), \" and the member is sent a receipt. Nothing is charged: to take the money from a member’s saved card, use \", _jsx(_components.code, {\n children: \"charge-saved-card\"\n }), \". A method that takes the money itself (Stripe, the Wallet) is refused with \", _jsx(_components.code, {\n children: \"400 TENDER_NOT_RECORDABLE\"\n }), \", a charge that owes nothing (or no longer owes what was read, because another payment landed first) with \", _jsx(_components.code, {\n children: \"409 CHARGE_NOT_OWED\"\n }), \", one with no contact with \", _jsx(_components.code, {\n children: \"400 CHARGE_HAS_NO_CONTACT\"\n }), \", and one a payment is already being taken for, such as a saved card being charged or one whose outcome Stripe has not confirmed, with \", _jsx(_components.code, {\n children: \"409 PAYMENT_IN_PROGRESS\"\n }), \": wait for that payment to settle. An API key reaches only the charges of bookings it made through the API; any other charge is a 404.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Record a payment for a charge","description":"Records that the member paid what a charge still owes, with one of your organization's own payment methods - money already taken at the desk, such as cash, a card on your own terminal or a bank transfer. The whole outstanding is recorded, the charge becomes `paid` and the member is sent a receipt. Nothing is charged: to take the money from a member's saved card, use `charge-saved-card`. A method that takes the money itself (Stripe, the Wallet) is refused with `400 TENDER_NOT_RECORDABLE`, a charge that owes nothing (or no longer owes what was read, because another payment landed first) with `409 CHARGE_NOT_OWED`, one with no contact with `400 CHARGE_HAS_NO_CONTACT`, and one a payment is already being taken for, such as a saved card being charged or one whose outcome Stripe has not confirmed, with `409 PAYMENT_IN_PROGRESS`: wait for that payment to settle. An API key reaches only the charges of bookings it made through the API; any other charge is a 404.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/record-payment","href":"/api-reference/transactions/record-a-payment-for-a-charge","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"recordPayment","summary":"Record a payment for a charge","description":"Records that the member paid what a charge still owes, with one of your organization's own payment methods - money already taken at the desk, such as cash, a card on your own terminal or a bank transfer. The whole outstanding is recorded, the charge becomes `paid` and the member is sent a receipt. Nothing is charged: to take the money from a member's saved card, use `charge-saved-card`. A method that takes the money itself (Stripe, the Wallet) is refused with `400 TENDER_NOT_RECORDABLE`, a charge that owes nothing (or no longer owes what was read, because another payment landed first) with `409 CHARGE_NOT_OWED`, one with no contact with `400 CHARGE_HAS_NO_CONTACT`, and one a payment is already being taken for, such as a saved card being charged or one whose outcome Stripe has not confirmed, with `409 PAYMENT_IN_PROGRESS`: wait for that payment to settle. An API key reaches only the charges of bookings it made through the API; any other charge is a 404.\n","tags":["Transactions"],"security":["fd1776ea-5884-40d6-86e8-65211caccd85"],"parameters":["ecd77fa6-fdcf-41b1-9de1-d209226aea43"],"requestBody":"5ee03a1d-0f44-4c11-9e05-d014d56a2177","responses":{"200":"69d9619f-5cd0-45ce-8b9d-b356d266e184","400":"635668a7-87ea-4ca5-9635-39616b6ba34f","401":"f18cdc16-6f16-4631-b9f6-8584403f19a7","403":"9b6f04aa-2746-492b-8900-460ca31e6a60","404":"9fef8133-97bf-4d63-b20e-13be79891d82","409":"90b6459e-343e-49e5-a20f-9f53490db7a8","429":"6832f35e-e868-4a25-a08c-1a8a60d1022f"},"method":"post","type":"path","servers":["27917f1d-a396-4e69-bdb9-9b4d7343a312"],"path":"/v1/platform/transactions/{id}/record-payment","baseUrlOptions":["https://api.1club.ai"],"title":"Record a payment for a charge","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ecd77fa6-fdcf-41b1-9de1-d209226aea43":{"in":"path","name":"id","required":true,"schema":{"type":"integer","isRequired":true,"uniqueKey":"","typeLabel":"integer"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentMethodDefinitionId"],"properties":{"paymentMethodDefinitionId":{"type":"integer","description":"One of your payment methods recorded by hand, from `GET /v1/platform/payment-methods`.","isRequired":true,"uniqueKey":"paymentMethodDefinitionId","typeLabel":"integer"},"paymentDate":{"type":"string","format":"date","description":"The day the money arrived, `YYYY-MM-DD` on the club's clock, never after today. Defaults to now.","uniqueKey":"paymentDate","typeLabel":"string\u003cdate>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"paymentMethodDefinitionId":123,"paymentDate":"2023-12-25"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"69d9619f-5cd0-45ce-8b9d-b356d266e184":{"description":"The charge, paid, with the payment recorded","content":{"application/json":{"schema":{"type":"object","description":"A billing transaction with amounts, payment status, and links to the originating booking or membership.","required":["outstanding","payment"],"properties":{"outstanding":{"type":"number","description":"What the charge still owes, tax included (0 once recorded)","isRequired":true,"uniqueKey":"outstanding","typeLabel":"number"},"payment":{"type":"object","required":["id","status"],"properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"payment.id","typeLabel":"integer"},"status":{"type":"string","enum":["succeeded"],"isRequired":true,"uniqueKey":"payment.status","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"payment","typeLabel":"object"},"id":{"type":"integer","uniqueKey":"id","typeLabel":"integer"},"uuid":{"type":"string","format":"uuid","description":"Stable unguessable identifier. Prefer this over `id` when storing a reference.","uniqueKey":"uuid","typeLabel":"string\u003cuuid>"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"transactionType":{"oneOf":[{"type":"string","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`.","uniqueKey":"transactionType.oneOf.0","typeLabel":"string"},{"type":"null","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`.","uniqueKey":"transactionType.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionType","typeLabel":"string | null"},"bookingId":{"oneOf":[{"type":"integer","uniqueKey":"bookingId.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"bookingId.oneOf.1","typeLabel":"null"}],"uniqueKey":"bookingId","typeLabel":"integer | null"},"membershipId":{"oneOf":[{"type":"integer","uniqueKey":"membershipId.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"membershipId.oneOf.1","typeLabel":"null"}],"uniqueKey":"membershipId","typeLabel":"integer | null"},"contactId":{"oneOf":[{"type":"integer","description":"The customer charged, when there is one.","uniqueKey":"contactId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The customer charged, when there is one.","uniqueKey":"contactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"contactId","typeLabel":"integer | null"},"clubId":{"oneOf":[{"type":"integer","description":"Set on a settlement only; other transactions take their club from their booking or membership.","uniqueKey":"clubId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Set on a settlement only; other transactions take their club from their booking or membership.","uniqueKey":"clubId.oneOf.1","typeLabel":"null"}],"uniqueKey":"clubId","typeLabel":"integer | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-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.","uniqueKey":"date","typeLabel":"string\u003cdate-time>"},"dueDate":{"oneOf":[{"type":"string","format":"date-time","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`.","uniqueKey":"dueDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","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`.","uniqueKey":"dueDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"dueDate","typeLabel":"string\u003cdate-time> | null"},"paymentStatus":{"type":"string","enum":["pending","paid","void","failed","settled","overdue","partially_paid","refunded","cancelled"],"uniqueKey":"paymentStatus","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"Pre-tax amount as a decimal string (e.g. \"25.00\"). Serialized as a string to preserve precision.","uniqueKey":"amount","typeLabel":"string"},"taxAmount":{"type":"string","description":"Tax portion as a decimal string.","uniqueKey":"taxAmount","typeLabel":"string"},"totalAmount":{"type":"string","description":"Total billed amount as a decimal string (amount + taxAmount).","uniqueKey":"totalAmount","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"outstanding":123,"payment":{"id":123,"status":"succeeded"},"id":123,"uuid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","description":"\u003cstring>","transactionType":"\u003cstring>","bookingId":123,"membershipId":123,"contactId":123,"clubId":123,"createdAt":"2023-11-07T05:31:56Z","date":"2023-11-07T05:31:56Z","dueDate":"2023-11-07T05:31:56Z","paymentStatus":"pending","amount":"\u003cstring>","taxAmount":"\u003cstring>","totalAmount":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"635668a7-87ea-4ca5-9635-39616b6ba34f":{"description":"Invalid request, a payment method that is not recorded by hand, a date after today, or a charge with no contact","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"f18cdc16-6f16-4631-b9f6-8584403f19a7":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"9b6f04aa-2746-492b-8900-460ca31e6a60":{"description":"API key is missing the required `payments:write` scope","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"9fef8133-97bf-4d63-b20e-13be79891d82":{"description":"Transaction not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"90b6459e-343e-49e5-a20f-9f53490db7a8":{"description":"The charge owes nothing (`CHARGE_NOT_OWED`), or another payment for it is being taken or awaits Stripe's answer (`PAYMENT_IN_PROGRESS`)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"6832f35e-e868-4a25-a08c-1a8a60d1022f":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"fd1776ea-5884-40d6-86e8-65211caccd85":{"customerApiAuth":{"type":"http","scheme":"bearer","description":"Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.","scopes":[],"schemeName":"customerApiAuth"}}},"servers":{"27917f1d-a396-4e69-bdb9-9b4d7343a312":{"url":"https://api.1club.ai","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.","scopes":[],"schemeName":"customerApiAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"customerApiAuth","name":"Authorization"}],"title":"customerApiAuth"}]},"originalFileLocation":"openapi-platform.json"},"subdomain":"1club","siteName":"1club Help","title":"Record a payment for a charge - 1club Help","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T14:37:40.564Z","originalFileLocation":"api-reference/transactions/record-a-payment-for-a-charge.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Records that the member paid what a charge still owes, with one of your organization\u0026#x27;s own payment methods - money already taken at the desk, such as cash, a card on your own terminal or a bank transfer. The whole outstanding is recorded, the charge becomes paid and the member is sent a receipt. Nothing is charged: to take the money from a member\u0026#x27;s saved card, use charge-saved-card. A method that takes the money itself (Stripe, the Wallet) is refused with 400 TENDER_NOT_RECORDABLE, a charge that owes nothing (or no longer owes what was read, because another payment landed first) with 409 CHARGE_NOT_OWED, one with no contact with 400 CHARGE_HAS_NO_CONTACT, and one a payment is already being taken for, such as a saved card being charged or one whose outcome Stripe has not confirmed, with 409 PAYMENT_IN_PROGRESS: wait for that payment to settle. An API key reaches only the charges of bookings it made through the API; any other charge is a 404.\">\u003cmeta data-mint-head name=\"application-name\" content=\"1club Help\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Record a payment for a charge - 1club Help\">\u003cmeta data-mint-head property=\"og:description\" content=\"Records that the member paid what a charge still owes, with one of your organization\u0026#x27;s own payment methods - money already taken at the desk, such as cash, a card on your own terminal or a bank transfer. The whole outstanding is recorded, the charge becomes paid and the member is sent a receipt. Nothing is charged: to take the money from a member\u0026#x27;s saved card, use charge-saved-card. A method that takes the money itself (Stripe, the Wallet) is refused with 400 TENDER_NOT_RECORDABLE, a charge that owes nothing (or no longer owes what was read, because another payment landed first) with 409 CHARGE_NOT_OWED, one with no contact with 400 CHARGE_HAS_NO_CONTACT, and one a payment is already being taken for, such as a saved card being charged or one whose outcome Stripe has not confirmed, with 409 PAYMENT_IN_PROGRESS: wait for that payment to settle. An API key reaches only the charges of bookings it made through the API; any other charge is a 404.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"1club Help\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.1club.ai/api-reference/transactions/record-a-payment-for-a-charge\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://1club.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Record+a+payment+for+a+charge\u0026amp;description=Records+that+the+member+paid+what+a+charge+still+owes%2C+with+one+of+your+organization%27s+own+payment+methods+-+money+already+taken+at+the+desk%2C+such+as+cash%2C+a+ca\u0026amp;theme=108ef4317c6d4ca4d46cff0f\u0026amp;signature=ce819c7ebaa6050fb7ecab82d66903506daf6c11fd8a31e6401c8dc304722ee7\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Record a payment for a charge - 1club Help\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Records that the member paid what a charge still owes, with one of your organization\u0026#x27;s own payment methods - money already taken at the desk, such as cash, a card on your own terminal or a bank transfer. The whole outstanding is recorded, the charge becomes paid and the member is sent a receipt. Nothing is charged: to take the money from a member\u0026#x27;s saved card, use charge-saved-card. A method that takes the money itself (Stripe, the Wallet) is refused with 400 TENDER_NOT_RECORDABLE, a charge that owes nothing (or no longer owes what was read, because another payment landed first) with 409 CHARGE_NOT_OWED, one with no contact with 400 CHARGE_HAS_NO_CONTACT, and one a payment is already being taken for, such as a saved card being charged or one whose outcome Stripe has not confirmed, with 409 PAYMENT_IN_PROGRESS: wait for that payment to settle. An API key reaches only the charges of bookings it made through the API; any other charge is a 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://1club.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Record+a+payment+for+a+charge\u0026amp;description=Records+that+the+member+paid+what+a+charge+still+owes%2C+with+one+of+your+organization%27s+own+payment+methods+-+money+already+taken+at+the+desk%2C+such+as+cash%2C+a+ca\u0026amp;theme=108ef4317c6d4ca4d46cff0f\u0026amp;signature=ce819c7ebaa6050fb7ecab82d66903506daf6c11fd8a31e6401c8dc304722ee7\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"1club Help\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#471EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.1club.ai/api-reference/transactions/record-a-payment-for-a-charge\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/transactions/record-a-payment-for-a-charge.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.1club.ai/#organization\",\"name\":\"1club Help\",\"url\":\"https://docs.1club.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/1club/HM7mOd-FIJUyvW_1/logo/light.svg?fit=max\u0026auto=format\u0026n=HM7mOd-FIJUyvW_1\u0026q=85\u0026s=d93b7eb86d0fd304bfe27889e979db38\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.1club.ai#website\",\"name\":\"1club Help\",\"url\":\"https://docs.1club.ai\",\"publisher\":{\"@id\":\"https://docs.1club.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.1club.ai/api-reference/transactions/record-a-payment-for-a-charge#webpage\",\"url\":\"https://docs.1club.ai/api-reference/transactions/record-a-payment-for-a-charge\",\"name\":\"Record a payment for a charge\",\"description\":\"Records that the member paid what a charge still owes, with one of your organization's own payment methods - money already taken at the desk, such as cash, a card on your own terminal or a bank transfer. The whole outstanding is recorded, the charge becomes paid and the member is sent a receipt. Nothing is charged: to take the money from a member's saved card, use charge-saved-card. A method that takes the money itself (Stripe, the Wallet) is refused with 400 TENDER_NOT_RECORDABLE, a charge that owes nothing (or no longer owes what was read, because another payment landed first) with 409 CHARGE_NOT_OWED, one with no contact with 400 CHARGE_HAS_NO_CONTACT, and one a payment is already being taken for, such as a saved card being charged or one whose outcome Stripe has not confirmed, with 409 PAYMENT_IN_PROGRESS: wait for that payment to settle. An API key reaches only the charges of bookings it made through the API; any other charge is a 404.\",\"dateModified\":\"2026-11-04T14:37:40.564Z\",\"isPartOf\":{\"@id\":\"https://docs.1club.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.1club.ai/api-reference/transactions/record-a-payment-for-a-charge#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.1club.ai/api-reference/transactions/record-a-payment-for-a-charge#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Transactions\",\"item\":\"https://docs.1club.ai/api-reference/transactions/list-transactions-for-the-organization\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Record a payment for a charge\",\"item\":\"https://docs.1club.ai/api-reference/transactions/record-a-payment-for-a-charge\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.1club.ai/api-reference/transactions/record-a-payment-for-a-charge#apireference\",\"headline\":\"Record a payment for a charge\",\"name\":\"Record a payment for a charge\",\"description\":\"Records that the member paid what a charge still owes, with one of your organization's own payment methods - money already taken at the desk, such as cash, a card on your own terminal or a bank transfer. The whole outstanding is recorded, the charge becomes paid and the member is sent a receipt. Nothing is charged: to take the money from a member's saved card, use charge-saved-card. A method that takes the money itself (Stripe, the Wallet) is refused with 400 TENDER_NOT_RECORDABLE, a charge that owes nothing (or no longer owes what was read, because another payment landed first) with 409 CHARGE_NOT_OWED, one with no contact with 400 CHARGE_HAS_NO_CONTACT, and one a payment is already being taken for, such as a saved card being charged or one whose outcome Stripe has not confirmed, with 409 PAYMENT_IN_PROGRESS: wait for that payment to settle. An API key reaches only the charges of bookings it made through the API; any other charge is a 404.\",\"url\":\"https://docs.1club.ai/api-reference/transactions/record-a-payment-for-a-charge\",\"mainEntityOfPage\":{\"@id\":\"https://docs.1club.ai/api-reference/transactions/record-a-payment-for-a-charge#webpage\"},\"dateModified\":\"2026-11-04T14:37:40.564Z\",\"publisher\":{\"@id\":\"https://docs.1club.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.1club.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"1club Help\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"1club Help","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"Settings","icon":"gear","pages":[{"title":"Settings","href":"/settings/overview"}]},{"tab":"API","icon":"code","groups":[{"group":"Getting Started","pages":[{"title":"1club Platform API reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"1club network API","sidebarTitle":"Network API","href":"/api-reference/marketplace-api"},{"title":"Versioning and deprecation","href":"/api-reference/versioning"},{"title":"Report changes","href":"/api-reference/changes"}]},{"group":"Channel integration","pages":[{"title":"Channel integration overview","href":"/api-reference/channel-integration/overview"},{"title":"Authentication","href":"/api-reference/channel-integration/authentication"},{"title":"Areas and availability","href":"/api-reference/channel-integration/areas-and-availability"},{"title":"Contacts","href":"/api-reference/channel-integration/contacts"},{"title":"Instructors","href":"/api-reference/channel-integration/instructors"},{"title":"Classes","href":"/api-reference/channel-integration/classes"},{"title":"Plans","href":"/api-reference/channel-integration/plans"},{"title":"Memberships","href":"/api-reference/channel-integration/memberships"},{"title":"Products","href":"/api-reference/channel-integration/products"},{"title":"Bookings","href":"/api-reference/channel-integration/bookings"},{"title":"Check-ins","href":"/api-reference/channel-integration/checkins"},{"title":"Idempotency","href":"/api-reference/channel-integration/idempotency"},{"title":"Webhooks","href":"/api-reference/channel-integration/webhooks"}]},{"group":"Area Blocks","pages":[{"title":"List area blocks","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/area-blocks","href":"/api-reference/area-blocks/list-area-blocks"},{"title":"Create an area block","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/area-blocks","href":"/api-reference/area-blocks/create-an-area-block"},{"title":"Delete an area block","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/area-blocks/{blockId}","href":"/api-reference/area-blocks/delete-an-area-block"}]},{"group":"Areas","pages":[{"title":"List area types","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/area-types","href":"/api-reference/areas/list-area-types"},{"title":"Create an area type","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/area-types","href":"/api-reference/areas/create-an-area-type"},{"title":"Get an area type","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/area-types/{id}","href":"/api-reference/areas/get-an-area-type"},{"title":"Update an area type","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/area-types/{id}","href":"/api-reference/areas/update-an-area-type"},{"title":"Reorder area types","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/area-types/order","href":"/api-reference/areas/reorder-area-types"},{"title":"List bookable areas","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/areas","href":"/api-reference/areas/list-bookable-areas"},{"title":"Create an area","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/areas","href":"/api-reference/areas/create-an-area"},{"title":"Get area availability","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/areas/{areaId}/availability","href":"/api-reference/areas/get-area-availability"},{"title":"Get an area","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/areas/{areaId}","href":"/api-reference/areas/get-an-area"},{"title":"Update an area","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/areas/{areaId}","href":"/api-reference/areas/update-an-area"},{"title":"Get club-wide availability grid","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/availability","href":"/api-reference/areas/get-club-wide-availability-grid"},{"title":"Availability change feed (reconciliation)","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/availability/changes","href":"/api-reference/areas/availability-change-feed-reconciliation"}]},{"group":"Booking Policies","pages":[{"title":"List booking policies","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/booking-policies","href":"/api-reference/booking-policies/list-booking-policies"},{"title":"Create a booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/booking-policies","href":"/api-reference/booking-policies/create-a-booking-policy"},{"title":"Resolve the effective booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/booking-policies/effective","href":"/api-reference/booking-policies/resolve-the-effective-booking-policy"},{"title":"Get a booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/booking-policies/{id}","href":"/api-reference/booking-policies/get-a-booking-policy"},{"title":"Delete a booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/booking-policies/{id}","href":"/api-reference/booking-policies/delete-a-booking-policy"},{"title":"Update a booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/booking-policies/{id}","href":"/api-reference/booking-policies/update-a-booking-policy"},{"title":"Duplicate a booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/booking-policies/{id}/duplicate","href":"/api-reference/booking-policies/duplicate-a-booking-policy"}]},{"group":"Bookings","pages":[{"title":"List bookings","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/bookings","href":"/api-reference/bookings/list-bookings"},{"title":"Create a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/bookings","href":"/api-reference/bookings/create-a-booking"},{"title":"Cancel a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/bookings/{id}/cancel","href":"/api-reference/bookings/cancel-a-booking"},{"title":"Get a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/bookings/{id}","href":"/api-reference/bookings/get-a-booking"},{"title":"Delete a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/bookings/{id}","href":"/api-reference/bookings/delete-a-booking"},{"title":"Update a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/bookings/{id}","href":"/api-reference/bookings/update-a-booking"},{"title":"Waive a booking's Cancellation Charge","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/bookings/{id}/cancellation-charge/waive","href":"/api-reference/bookings/waive-a-bookings-cancellation-charge"},{"title":"List the additional players on a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/bookings/{id}/participants","href":"/api-reference/bookings/list-the-additional-players-on-a-booking"},{"title":"Add a player to a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/bookings/{id}/participants","href":"/api-reference/bookings/add-a-player-to-a-booking"},{"title":"Remove a player from a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/bookings/{id}/participants/{contactId}","href":"/api-reference/bookings/remove-a-player-from-a-booking"}]},{"group":"Check-ins","pages":[{"title":"List check-ins","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/checkins","href":"/api-reference/check-ins/list-check-ins"},{"title":"Check in a booking or a member","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/checkins","href":"/api-reference/check-ins/check-in-a-booking-or-a-member"},{"title":"Get a check-in","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/checkins/{id}","href":"/api-reference/check-ins/get-a-check-in"}]},{"group":"Classes","pages":[{"title":"List class types","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/class-types","href":"/api-reference/classes/list-class-types"},{"title":"Create a class type","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/class-types","href":"/api-reference/classes/create-a-class-type"},{"title":"Get a class type","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/class-types/{id}","href":"/api-reference/classes/get-a-class-type"},{"title":"Update a class type","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/class-types/{id}","href":"/api-reference/classes/update-a-class-type"},{"title":"Reorder class types","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/class-types/order","href":"/api-reference/classes/reorder-class-types"},{"title":"List classes","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/classes","href":"/api-reference/classes/list-classes"},{"title":"Create a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/classes","href":"/api-reference/classes/create-a-class"},{"title":"List a class's roster","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/classes/{id}/bookings","href":"/api-reference/classes/list-a-classs-roster"},{"title":"Book a customer into a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/classes/{id}/bookings","href":"/api-reference/classes/book-a-customer-into-a-class"},{"title":"Get a class by ID","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/classes/{id}","href":"/api-reference/classes/get-a-class-by-id"},{"title":"Delete a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/classes/{id}","href":"/api-reference/classes/delete-a-class"},{"title":"Update a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/classes/{id}","href":"/api-reference/classes/update-a-class"},{"title":"List programs","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/programs","href":"/api-reference/classes/list-programs"},{"title":"Create a program","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/programs","href":"/api-reference/classes/create-a-program"},{"title":"Get a program","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/programs/{id}","href":"/api-reference/classes/get-a-program"},{"title":"Update a program","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/programs/{id}","href":"/api-reference/classes/update-a-program"},{"title":"List progression tracks","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/progression-tracks","href":"/api-reference/classes/list-progression-tracks"},{"title":"Create a progression track","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/progression-tracks","href":"/api-reference/classes/create-a-progression-track"},{"title":"Get a progression track","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/progression-tracks/{id}","href":"/api-reference/classes/get-a-progression-track"},{"title":"Update a progression track","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/progression-tracks/{id}","href":"/api-reference/classes/update-a-progression-track"}]},{"group":"Clubs","pages":[{"title":"List clubs","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/clubs","href":"/api-reference/clubs/list-clubs"},{"title":"Get club details by slug","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/clubs/{slug}","href":"/api-reference/clubs/get-club-details-by-slug"},{"title":"Update a club's booking-card labels","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/clubs/{slug}","href":"/api-reference/clubs/update-a-clubs-booking-card-labels"},{"title":"Update a club's profile","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/clubs/{slug}/profile","href":"/api-reference/clubs/update-a-clubs-profile"}]},{"group":"Competitors","pages":[{"title":"List competitors","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors","href":"/api-reference/competitors/list-competitors"},{"title":"Add a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/competitors","href":"/api-reference/competitors/add-a-competitor"},{"title":"Compare prices with the market","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors/market","href":"/api-reference/competitors/compare-prices-with-the-market"},{"title":"Import competitors from the AI report","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/competitors/import-ai-report","href":"/api-reference/competitors/import-competitors-from-the-ai-report"},{"title":"Get a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors/{id}","href":"/api-reference/competitors/get-a-competitor"},{"title":"Remove a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/competitors/{id}","href":"/api-reference/competitors/remove-a-competitor"},{"title":"Update a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/competitors/{id}","href":"/api-reference/competitors/update-a-competitor"},{"title":"Analyse a competitor's reviews","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors/{id}/analysis","href":"/api-reference/competitors/analyse-a-competitors-reviews"},{"title":"Read a competitor's website again","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/competitors/{id}/refresh","href":"/api-reference/competitors/read-a-competitors-website-again"}]},{"group":"Contacts","pages":[{"title":"List and search contacts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts","href":"/api-reference/contacts/list-and-search-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts/{id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Archive a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/contacts/{id}","href":"/api-reference/contacts/archive-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/contacts/{id}","href":"/api-reference/contacts/update-a-contact"},{"title":"List sales pipeline stages","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pipeline-stages","href":"/api-reference/contacts/list-sales-pipeline-stages"},{"title":"List contact sources","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contact-sources","href":"/api-reference/contacts/list-contact-sources"},{"title":"List a track's members","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/progression-tracks/{id}/members","href":"/api-reference/contacts/list-a-tracks-members"},{"title":"Give members a rank","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/progression-tracks/{id}/ranks","href":"/api-reference/contacts/give-members-a-rank"},{"title":"Get a contact's ranks","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts/{contactId}/progression","href":"/api-reference/contacts/get-a-contacts-ranks"}]},{"group":"Content","pages":[{"title":"List content","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/content","href":"/api-reference/content/list-content"},{"title":"Create content","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/content","href":"/api-reference/content/create-content"},{"title":"Get published content by slug","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/content/{slug}","href":"/api-reference/content/get-published-content-by-slug"},{"title":"Delete content","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/content/{contentId}","href":"/api-reference/content/delete-content"},{"title":"Update content","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/content/{contentId}","href":"/api-reference/content/update-content"}]},{"group":"Custom Fields","pages":[{"title":"List contact custom fields","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/custom-fields","href":"/api-reference/custom-fields/list-contact-custom-fields"},{"title":"Create a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/custom-fields","href":"/api-reference/custom-fields/create-a-contact-custom-field"},{"title":"Get a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/custom-fields/{id}","href":"/api-reference/custom-fields/get-a-contact-custom-field"},{"title":"Delete a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/custom-fields/{id}","href":"/api-reference/custom-fields/delete-a-contact-custom-field"},{"title":"Update a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/custom-fields/{id}","href":"/api-reference/custom-fields/update-a-contact-custom-field"},{"title":"Get a contact's custom field values","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts/{contactId}/custom-fields","href":"/api-reference/custom-fields/get-a-contacts-custom-field-values"},{"title":"Set a contact's custom field values","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/contacts/{contactId}/custom-fields","href":"/api-reference/custom-fields/set-a-contacts-custom-field-values"}]},{"group":"Document Rules","pages":[{"title":"List document rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/document-rules","href":"/api-reference/document-rules/list-document-rules"},{"title":"Create a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/document-rules","href":"/api-reference/document-rules/create-a-document-rule"},{"title":"Get a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/document-rules/{id}","href":"/api-reference/document-rules/get-a-document-rule"},{"title":"Delete a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/document-rules/{id}","href":"/api-reference/document-rules/delete-a-document-rule"},{"title":"Update a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/document-rules/{id}","href":"/api-reference/document-rules/update-a-document-rule"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/events","href":"/api-reference/events/list-events"},{"title":"Create an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events","href":"/api-reference/events/create-an-event"},{"title":"Get an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/events/{id}","href":"/api-reference/events/get-an-event"},{"title":"Delete an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/events/{id}","href":"/api-reference/events/delete-an-event"},{"title":"Update an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/events/{id}","href":"/api-reference/events/update-an-event"},{"title":"Publish an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/publish","href":"/api-reference/events/publish-an-event"},{"title":"Unpublish an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/unpublish","href":"/api-reference/events/unpublish-an-event"},{"title":"Cancel an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/cancel","href":"/api-reference/events/cancel-an-event"},{"title":"Duplicate an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/duplicate","href":"/api-reference/events/duplicate-an-event"},{"title":"List an event's attendees","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/events/{id}/bookings","href":"/api-reference/events/list-an-events-attendees"},{"title":"Register a customer for an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/bookings","href":"/api-reference/events/register-a-customer-for-an-event"}]},{"group":"External Programs","pages":[{"title":"List external programs","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/external-programs","href":"/api-reference/external-programs/list-external-programs"},{"title":"Create an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/external-programs","href":"/api-reference/external-programs/create-an-external-program"},{"title":"Get an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/external-programs/{id}","href":"/api-reference/external-programs/get-an-external-program"},{"title":"Delete an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/external-programs/{id}","href":"/api-reference/external-programs/delete-an-external-program"},{"title":"Update an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/external-programs/{id}","href":"/api-reference/external-programs/update-an-external-program"}]},{"group":"Forms","pages":[{"title":"List forms","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/forms","href":"/api-reference/forms/list-forms"},{"title":"Create a form","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/forms","href":"/api-reference/forms/create-a-form"},{"title":"Get a form","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/forms/{id}","href":"/api-reference/forms/get-a-form"},{"title":"Update a form","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/forms/{id}","href":"/api-reference/forms/update-a-form"},{"title":"Set a fill-in form's questions","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/forms/{id}/questions","href":"/api-reference/forms/set-a-fill-in-forms-questions"}]},{"group":"Staff Roster","pages":[{"title":"List the staff roster","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-shifts","href":"/api-reference/staff-roster/list-the-staff-roster"},{"title":"Add a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-shifts","href":"/api-reference/staff-roster/add-a-shift"},{"title":"Get a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-shifts/{id}","href":"/api-reference/staff-roster/get-a-shift"},{"title":"Delete a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/instructor-shifts/{id}","href":"/api-reference/staff-roster/delete-a-shift"},{"title":"Edit a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructor-shifts/{id}","href":"/api-reference/staff-roster/edit-a-shift"},{"title":"Cancel a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-shifts/{id}/cancel","href":"/api-reference/staff-roster/cancel-a-shift"},{"title":"List instructor time off","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-time-off","href":"/api-reference/staff-roster/list-instructor-time-off"},{"title":"Book a coach off","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-time-off","href":"/api-reference/staff-roster/book-a-coach-off"},{"title":"Remove instructor time off","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/instructor-time-off/{id}","href":"/api-reference/staff-roster/remove-instructor-time-off"},{"title":"Change instructor time off","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructor-time-off/{id}","href":"/api-reference/staff-roster/change-instructor-time-off"},{"title":"List rotation assignments","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-rotation-assignments","href":"/api-reference/staff-roster/list-rotation-assignments"},{"title":"Assign a coach to a rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/shift-rotation-assignments","href":"/api-reference/staff-roster/assign-a-coach-to-a-rotation"},{"title":"Remove a rotation assignment","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/shift-rotation-assignments/{id}","href":"/api-reference/staff-roster/remove-a-rotation-assignment"},{"title":"Update a rotation assignment","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/shift-rotation-assignments/{id}","href":"/api-reference/staff-roster/update-a-rotation-assignment"},{"title":"List shift rotations","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-rotations","href":"/api-reference/staff-roster/list-shift-rotations"},{"title":"Create a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/shift-rotations","href":"/api-reference/staff-roster/create-a-shift-rotation"},{"title":"Get a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-rotations/{id}","href":"/api-reference/staff-roster/get-a-shift-rotation"},{"title":"Delete a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/shift-rotations/{id}","href":"/api-reference/staff-roster/delete-a-shift-rotation"},{"title":"Update a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/shift-rotations/{id}","href":"/api-reference/staff-roster/update-a-shift-rotation"},{"title":"List shift templates","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-templates","href":"/api-reference/staff-roster/list-shift-templates"},{"title":"Create a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/shift-templates","href":"/api-reference/staff-roster/create-a-shift-template"},{"title":"Get a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-templates/{id}","href":"/api-reference/staff-roster/get-a-shift-template"},{"title":"Delete a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/shift-templates/{id}","href":"/api-reference/staff-roster/delete-a-shift-template"},{"title":"Update a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/shift-templates/{id}","href":"/api-reference/staff-roster/update-a-shift-template"}]},{"group":"Instructors","pages":[{"title":"List instructor types","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-types","href":"/api-reference/instructors/list-instructor-types"},{"title":"Create an instructor type","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-types","href":"/api-reference/instructors/create-an-instructor-type"},{"title":"Get an instructor type","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-types/{id}","href":"/api-reference/instructors/get-an-instructor-type"},{"title":"Update an instructor type","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructor-types/{id}","href":"/api-reference/instructors/update-an-instructor-type"},{"title":"Reorder instructor types","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/instructor-types/order","href":"/api-reference/instructors/reorder-instructor-types"},{"title":"List and search instructors","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructors","href":"/api-reference/instructors/list-and-search-instructors"},{"title":"Create an instructor","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructors","href":"/api-reference/instructors/create-an-instructor"},{"title":"Get an instructor","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructors/{id}","href":"/api-reference/instructors/get-an-instructor"},{"title":"Update an instructor","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructors/{id}","href":"/api-reference/instructors/update-an-instructor"}]},{"group":"Invoices","pages":[{"title":"Summarize what was invoiced","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/invoices/summary","href":"/api-reference/invoices/summarize-what-was-invoiced"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/invoices/{id}","href":"/api-reference/invoices/get-an-invoice"}]},{"group":"Account","pages":[{"title":"Describe the API key's organization and granted scopes","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/me","href":"/api-reference/account/describe-the-api-keys-organization-and-granted-scopes"}]},{"group":"Media","pages":[{"title":"List media","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/media","href":"/api-reference/media/list-media"},{"title":"Register a file in the media library","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/media","href":"/api-reference/media/register-a-file-in-the-media-library"},{"title":"Get one media item","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/media/{mediaId}","href":"/api-reference/media/get-one-media-item"},{"title":"Delete a media item","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/media/{mediaId}","href":"/api-reference/media/delete-a-media-item"},{"title":"Update media metadata","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/media/{mediaId}","href":"/api-reference/media/update-media-metadata"}]},{"group":"Member Accounts","pages":[{"title":"List household and company accounts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/member-accounts","href":"/api-reference/member-accounts/list-household-and-company-accounts"},{"title":"Create a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/member-accounts","href":"/api-reference/member-accounts/create-a-household-or-company-account"},{"title":"Get a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/member-accounts/{id}","href":"/api-reference/member-accounts/get-a-household-or-company-account"},{"title":"Delete a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/member-accounts/{id}","href":"/api-reference/member-accounts/delete-a-household-or-company-account"},{"title":"Update a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/member-accounts/{id}","href":"/api-reference/member-accounts/update-a-household-or-company-account"},{"title":"Add a member to an account","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/member-accounts/{id}/members","href":"/api-reference/member-accounts/add-a-member-to-an-account"},{"title":"Remove a member from an account","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/member-accounts/{id}/members/{contactId}","href":"/api-reference/member-accounts/remove-a-member-from-an-account"},{"title":"Change a member's role","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/member-accounts/{id}/members/{contactId}","href":"/api-reference/member-accounts/change-a-members-role"}]},{"group":"Memberships","pages":[{"title":"List memberships","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/memberships","href":"/api-reference/memberships/list-memberships"},{"title":"Create a membership","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/memberships","href":"/api-reference/memberships/create-a-membership"},{"title":"Get a membership","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/memberships/{id}","href":"/api-reference/memberships/get-a-membership"},{"title":"Update a membership","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/memberships/{id}","href":"/api-reference/memberships/update-a-membership"},{"title":"Adjust a membership's sessions","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/memberships/{id}/session-adjustments","href":"/api-reference/memberships/adjust-a-memberships-sessions"}]},{"group":"Messages","pages":[{"title":"List messages","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/messages","href":"/api-reference/messages/list-messages"},{"title":"Create a message draft","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/messages","href":"/api-reference/messages/create-a-message-draft"},{"title":"Get a message","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/messages/{id}","href":"/api-reference/messages/get-a-message"},{"title":"Delete a message draft","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/messages/{id}","href":"/api-reference/messages/delete-a-message-draft"},{"title":"Update a message draft","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/messages/{id}","href":"/api-reference/messages/update-a-message-draft"}]},{"group":"Notifications","pages":[{"title":"Get notification settings","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/notification-settings","href":"/api-reference/notifications/get-notification-settings"},{"title":"Update a notification setting","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/notification-settings","href":"/api-reference/notifications/update-a-notification-setting"},{"title":"Apply notification settings to everyone in a role","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/notification-settings/apply","href":"/api-reference/notifications/apply-notification-settings-to-everyone-in-a-role"}]},{"group":"Pay Rate Policies","pages":[{"title":"List what coaches earned","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pay-ledger","href":"/api-reference/pay-rate-policies/list-what-coaches-earned"},{"title":"List pay rate policies","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pay-rate-policies","href":"/api-reference/pay-rate-policies/list-pay-rate-policies"},{"title":"Create a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pay-rate-policies","href":"/api-reference/pay-rate-policies/create-a-pay-rate-policy"},{"title":"Get a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pay-rate-policies/{id}","href":"/api-reference/pay-rate-policies/get-a-pay-rate-policy"},{"title":"Update a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/pay-rate-policies/{id}","href":"/api-reference/pay-rate-policies/update-a-pay-rate-policy"},{"title":"Put instructors on a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pay-rate-policies/{id}/instructors","href":"/api-reference/pay-rate-policies/put-instructors-on-a-pay-rate-policy"},{"title":"Take an instructor off a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/pay-rate-policies/{id}/instructors/{instructorId}","href":"/api-reference/pay-rate-policies/take-an-instructor-off-a-pay-rate-policy"}]},{"group":"Payment Methods","pages":[{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/payment-methods","href":"/api-reference/payment-methods/list-payment-methods"},{"title":"Create a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/payment-methods","href":"/api-reference/payment-methods/create-a-payment-method"},{"title":"Get a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/payment-methods/{id}","href":"/api-reference/payment-methods/get-a-payment-method"},{"title":"Delete a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/payment-methods/{id}","href":"/api-reference/payment-methods/delete-a-payment-method"},{"title":"Update a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/payment-methods/{id}","href":"/api-reference/payment-methods/update-a-payment-method"}]},{"group":"Plans","pages":[{"title":"List membership plan categories","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plan-categories","href":"/api-reference/plans/list-membership-plan-categories"},{"title":"Create a membership plan category","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/plan-categories","href":"/api-reference/plans/create-a-membership-plan-category"},{"title":"Get a membership plan category","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plan-categories/{id}","href":"/api-reference/plans/get-a-membership-plan-category"},{"title":"Update a membership plan category","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/plan-categories/{id}","href":"/api-reference/plans/update-a-membership-plan-category"},{"title":"List and search membership plans","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plans","href":"/api-reference/plans/list-and-search-membership-plans"},{"title":"Create a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/plans","href":"/api-reference/plans/create-a-membership-plan"},{"title":"Get a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plans/{id}","href":"/api-reference/plans/get-a-membership-plan"},{"title":"Delete a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/plans/{id}","href":"/api-reference/plans/delete-a-membership-plan"},{"title":"Update a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/plans/{id}","href":"/api-reference/plans/update-a-membership-plan"}]},{"group":"Pricing Rules","pages":[{"title":"List pricing rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pricing-rules","href":"/api-reference/pricing-rules/list-pricing-rules"},{"title":"Create a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pricing-rules","href":"/api-reference/pricing-rules/create-a-pricing-rule"},{"title":"Quote a booking price","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pricing-rules/quote","href":"/api-reference/pricing-rules/quote-a-booking-price"},{"title":"Get a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pricing-rules/{id}","href":"/api-reference/pricing-rules/get-a-pricing-rule"},{"title":"Delete a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/pricing-rules/{id}","href":"/api-reference/pricing-rules/delete-a-pricing-rule"},{"title":"Update a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/pricing-rules/{id}","href":"/api-reference/pricing-rules/update-a-pricing-rule"}]},{"group":"Products","pages":[{"title":"List product categories","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/product-categories","href":"/api-reference/products/list-product-categories"},{"title":"Create a product category","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/product-categories","href":"/api-reference/products/create-a-product-category"},{"title":"Get a product category","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/product-categories/{id}","href":"/api-reference/products/get-a-product-category"},{"title":"Update a product category","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/product-categories/{id}","href":"/api-reference/products/update-a-product-category"},{"title":"List and search products","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/products","href":"/api-reference/products/list-and-search-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/products","href":"/api-reference/products/create-a-product"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/products/{id}","href":"/api-reference/products/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/products/{id}","href":"/api-reference/products/update-a-product"},{"title":"Get how many are left to sell","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/products/{id}/availability","href":"/api-reference/products/get-how-many-are-left-to-sell"}]},{"group":"Promotions","pages":[{"title":"List promotions","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/promotions","href":"/api-reference/promotions/list-promotions"},{"title":"Get a promotion","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/promotions/{id}","href":"/api-reference/promotions/get-a-promotion"}]},{"group":"Reports","pages":[{"title":"Revenue report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/revenue","href":"/api-reference/reports/revenue-report-for-a-period"},{"title":"Activity report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/activity","href":"/api-reference/reports/activity-report-for-a-period"},{"title":"Memberships report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/memberships","href":"/api-reference/reports/memberships-report-for-a-period"},{"title":"Members report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/members","href":"/api-reference/reports/members-report-for-a-period"},{"title":"What each report figure counts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/definitions","href":"/api-reference/reports/what-each-report-figure-counts"},{"title":"What one report figure counts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/definitions/{metric}","href":"/api-reference/reports/what-one-report-figure-counts"}]},{"group":"Revenue Accounts","pages":[{"title":"List revenue accounts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/revenue-accounts","href":"/api-reference/revenue-accounts/list-revenue-accounts"},{"title":"Create a revenue account","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/revenue-accounts","href":"/api-reference/revenue-accounts/create-a-revenue-account"},{"title":"Get a revenue account","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/revenue-accounts/{id}","href":"/api-reference/revenue-accounts/get-a-revenue-account"},{"title":"Update a revenue account","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/revenue-accounts/{id}","href":"/api-reference/revenue-accounts/update-a-revenue-account"}]},{"group":"Setup","pages":[{"title":"Get the club setup checklist","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/setup-checklist","href":"/api-reference/setup/get-the-club-setup-checklist"},{"title":"Mark a setup step","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/setup-checklist/steps/{step}","href":"/api-reference/setup/mark-a-setup-step"}]},{"group":"Staff","pages":[{"title":"List staff","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/staff","href":"/api-reference/staff/list-staff"},{"title":"Change a staff member's role","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/staff/{userId}/role","href":"/api-reference/staff/change-a-staff-members-role"},{"title":"Get role permissions","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/role-permissions","href":"/api-reference/staff/get-role-permissions"},{"title":"Reset a role's permissions","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/role-permissions/{role}","href":"/api-reference/staff/reset-a-roles-permissions"},{"title":"Change a role's permissions","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/role-permissions/{role}","href":"/api-reference/staff/change-a-roles-permissions"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/tags/{id}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/tags/{id}","href":"/api-reference/tags/update-a-tag"},{"title":"Tag contacts","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/contact-tags/add","href":"/api-reference/tags/tag-contacts"},{"title":"Untag contacts","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/contact-tags/remove","href":"/api-reference/tags/untag-contacts"},{"title":"Get smart tag rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/smart-tag-settings","href":"/api-reference/tags/get-smart-tag-rules"},{"title":"Update smart tag rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/smart-tag-settings","href":"/api-reference/tags/update-smart-tag-rules"}]},{"group":"Templates","pages":[{"title":"List message templates","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates","href":"/api-reference/templates/list-message-templates"},{"title":"Create a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/templates","href":"/api-reference/templates/create-a-message-template"},{"title":"List the variables a template may use","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates/variables","href":"/api-reference/templates/list-the-variables-a-template-may-use"},{"title":"List the customizable system emails","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates/system","href":"/api-reference/templates/list-the-customizable-system-emails"},{"title":"Customize a system email","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/templates/system/{key}/copy","href":"/api-reference/templates/customize-a-system-email"},{"title":"Get a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates/{id}","href":"/api-reference/templates/get-a-message-template"},{"title":"Delete a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/templates/{id}","href":"/api-reference/templates/delete-a-message-template"},{"title":"Update a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/templates/{id}","href":"/api-reference/templates/update-a-message-template"}]},{"group":"Transactions","pages":[{"title":"List transactions for the organization","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/transactions","href":"/api-reference/transactions/list-transactions-for-the-organization"},{"title":"Record a settlement","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions","href":"/api-reference/transactions/record-a-settlement"},{"title":"Get a transaction by ID","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/transactions/{id}","href":"/api-reference/transactions/get-a-transaction-by-id"},{"title":"Delete an unpaid charge","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/transactions/{id}","href":"/api-reference/transactions/delete-an-unpaid-charge"},{"title":"Refund a settlement","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/refund","href":"/api-reference/transactions/refund-a-settlement"},{"title":"Void an unpaid charge","description":"Marks a charge as never owed: it leaves the member's amount due, bill runs and revenue. Nothing is deleted - the transaction stays in the ledger with `paymentStatus: void`. Only an unpaid charge can be voided (`pending`, `overdue` or `failed`). A paid one is refused with `409 PAID_TRANSACTION_REQUIRES_REFUND`, since voiding it would erase a real sale, and a settled or cancelled one with `409 CLOSED_TRANSACTION_NOT_VOIDABLE`. An API key reaches only the charges of bookings it made through the API, and never another key's managed booking; any other charge is a 404.\n\nWhen the charge was the last one of a pass that was never paid, the pass is cancelled with it, with its bookings still ahead; `releasedMembershipIds` names them.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/void","href":"/api-reference/transactions/void-an-unpaid-charge"},{"title":"Record a payment for a charge","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/record-payment","href":"/api-reference/transactions/record-a-payment-for-a-charge"},{"title":"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.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/charge-saved-card","href":"/api-reference/transactions/charge-a-charge-to-the-members-saved-card"}]},{"group":"Website","pages":[{"title":"Get the website","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website","href":"/api-reference/website/get-the-website"},{"title":"Update website-level settings","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/website","href":"/api-reference/website/update-website-level-settings"},{"title":"List the organization's websites","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/sites","href":"/api-reference/website/list-the-organizations-websites"},{"title":"Get the section-type catalog","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/section-types","href":"/api-reference/website/get-the-section-type-catalog"},{"title":"Get the design-token catalog","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/theme-tokens","href":"/api-reference/website/get-the-design-token-catalog"},{"title":"Get the website's theme","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/theme","href":"/api-reference/website/get-the-websites-theme"},{"title":"Set the website's design tokens","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/website/theme","href":"/api-reference/website/set-the-websites-design-tokens"},{"title":"Get the website's custom CSS","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/css","href":"/api-reference/website/get-the-websites-custom-css"},{"title":"Replace the website's custom CSS","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/website/css","href":"/api-reference/website/replace-the-websites-custom-css"},{"title":"List the website's pages","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/pages","href":"/api-reference/website/list-the-websites-pages"},{"title":"Add a page","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/website/pages","href":"/api-reference/website/add-a-page"},{"title":"Get one page","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/pages/{slug}","href":"/api-reference/website/get-one-page"},{"title":"Update a page","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/website/pages/{slug}","href":"/api-reference/website/update-a-page"},{"title":"Delete a page","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/website/pages/{slug}","href":"/api-reference/website/delete-a-page"},{"title":"List publish history","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/releases","href":"/api-reference/website/list-publish-history"},{"title":"Publish the website","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/website/releases","href":"/api-reference/website/publish-the-website"},{"title":"Add a section to a page","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/website/pages/{slug}/sections","href":"/api-reference/website/add-a-section-to-a-page"},{"title":"Remove a section from a page","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/website/pages/{slug}/sections/{index}","href":"/api-reference/website/remove-a-section-from-a-page"},{"title":"Update a section's config","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/website/pages/{slug}/sections/{index}","href":"/api-reference/website/update-a-sections-config"},{"title":"Update the site header or footer","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/website/layout/{slot}","href":"/api-reference/website/update-the-site-header-or-footer"},{"title":"Roll back to an earlier release","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/website/releases/{releaseId}/rollback","href":"/api-reference/website/roll-back-to-an-earlier-release"}]}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Record a payment for a charge - 1club Help","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}