# Faithful YAML rendering of the provider-published spec saved verbatim at openapi/_original/hilt-so-api-openapi.json # fetched 2026-09-19 from the URL in info.x-source-url of that file's sibling manifest; content unchanged. openapi: 3.1.0 info: title: Hilt API description: Hilt Pay Workspace and Hilt Pay API routes for zero-custody Solana checkout, MPP metered payment channels, receipts, memberships, entitlements, native subscriptions, webhooks, and support context. version: 1.0.0 contact: name: Hilt url: https://www.hilt.so email: hello@hilt.so x-guidance: Start with POST /v1/access/agent-bootstrap. An agent can purchase 30 days of Starter, Growth, or Scale through the matching x402 V2 activation endpoint paid in Solana USDC. For metered integrations, settle PAYMENT-SIGNATURE through POST /v1/access/x402/settle and atomically consume through POST /v1/access/entitlements/consume before serving. Never send private keys, seed phrases, or wallet secrets. paths: /health: get: tags: - system summary: Health operationId: health_health_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/HealthResponse' /v1/health: get: tags: - system summary: Health V1 operationId: health_v1_v1_health_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/HealthResponse' /v1/auth/register: post: tags: - auth summary: Register description: Creates a new Hilt merchant account on the free plan. operationId: register_v1_auth_register_post requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AuthResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/auth/login: post: tags: - auth summary: Login description: Password-based login. Returns JWT on success with full entitlement claims. operationId: login_v1_auth_login_post requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AuthResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/auth/wallet: post: tags: - auth summary: Wallet Auth description: 'Phantom wallet-based authentication. Verifies the signed nonce, creates or retrieves the user account. Wallet-only accounts have no email so is_staff is always False.' operationId: wallet_auth_v1_auth_wallet_post requestBody: content: application/json: schema: $ref: '#/components/schemas/WalletAuthRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AuthResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/auth/oauth/providers: get: tags: - auth summary: Oauth Provider Status operationId: oauth_provider_status_v1_auth_oauth_providers_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OAuthProviderStatusResponse' /v1/auth/oauth/{provider}/start: get: tags: - auth summary: Oauth Start operationId: oauth_start_v1_auth_oauth__provider__start_get parameters: - name: provider in: path required: true schema: type: string title: Provider - name: mode in: query required: false schema: type: string default: login title: Mode - name: next in: query required: false schema: anyOf: - type: string - type: 'null' title: Next - name: surface in: query required: false schema: anyOf: - type: string - type: 'null' title: Surface responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OAuthStartResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/auth/oauth/{provider}/callback: get: tags: - auth summary: Oauth Callback operationId: oauth_callback_v1_auth_oauth__provider__callback_get parameters: - name: provider in: path required: true schema: type: string title: Provider - name: code in: query required: false schema: anyOf: - type: string - type: 'null' title: Code - name: state in: query required: false schema: anyOf: - type: string - type: 'null' title: State - name: error in: query required: false schema: anyOf: - type: string - type: 'null' title: Error - name: error_description in: query required: false schema: anyOf: - type: string - type: 'null' title: Error Description responses: '302': description: Redirect to the Hilt application after OAuth. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/auth/logout: post: tags: - auth summary: Logout description: 'Logs out the current session. For stateless JWTs this is a no-op server-side. Clients should discard the token locally.' operationId: logout_v1_auth_logout_post responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DetailResponse' /v1/auth/refresh: post: tags: - auth summary: Refresh Token description: 'Refreshes a JWT that is still valid. Issues a new token with a fresh TTL and re-derives entitlement claims from the database so subscription changes are reflected immediately.' operationId: refresh_token_v1_auth_refresh_post requestBody: content: application/json: schema: $ref: '#/components/schemas/RefreshRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AuthResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/account/me: get: tags: - account summary: Get Me description: 'Returns the authenticated user''s full profile for dashboard bootstrap. This is the primary endpoint for dashboard bootstrap.' operationId: get_me_v1_account_me_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccountResponse' patch: tags: - account summary: Update Me description: Updates mutable fields on the user profile. operationId: update_me_v1_account_me_patch requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountUpdateRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UpdatedFieldsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/account/summary: get: tags: - account summary: Get Account Summary description: 'Returns the merchant-facing dashboard summary used by the sidebar and overview. Figures are grouped by asset so we do not collapse USDC and SOL into one fake number.' operationId: get_account_summary_v1_account_summary_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccountSummaryResponse' /v1/account/analytics: get: tags: - account summary: Get Account Analytics operationId: get_account_analytics_v1_account_analytics_get parameters: - name: window_days in: query required: false schema: type: integer maximum: 90 minimum: 3 default: 30 title: Window Days - name: daily_days in: query required: false schema: type: integer maximum: 30 minimum: 3 default: 14 title: Daily Days - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: Start Date - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' title: End Date responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WorkspaceAnalyticsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/account/me/security: patch: tags: - account summary: Update Account Security description: Updates merchant email and password details for hilt.so sign-in. operationId: update_account_security_v1_account_me_security_patch requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountSecurityUpdateRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UpdatedFieldsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/account/delivery/readiness: get: tags: - account summary: Get Delivery Readiness operationId: get_delivery_readiness_v1_account_delivery_readiness_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DeliveryReadinessResponse' /v1/account/delivery/test: post: tags: - account summary: Run Delivery Test operationId: run_delivery_test_v1_account_delivery_test_post requestBody: content: application/json: schema: $ref: '#/components/schemas/DeliveryTestRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DeliveryTestResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/account/account: delete: tags: - account summary: Delete Account description: 'Soft-deletes the account. Sets deleted_at timestamp and status = ''deleted''. GDPR-compliant: user data is pseudonymised, not hard-deleted.' operationId: delete_account_v1_account_account_delete responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DetailResponse' /v1/keys: get: tags: - api-keys summary: List Keys description: Lists all API keys for the authenticated user (excludes raw values). operationId: list_keys_v1_keys_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/KeySummary' type: array title: Response List Keys V1 Keys Get post: tags: - api-keys summary: Create Key description: 'Creates a new API key. The raw key value is returned ONCE and cannot be retrieved again. Store it in a secrets manager immediately.' operationId: create_key_v1_keys_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateKeyRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreateKeyResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/keys/{key_id}: delete: tags: - api-keys summary: Revoke Key description: 'Revokes an API key. Revocation is immediate and permanent. Requests using this key will receive HTTP 401 from the next request onwards.' operationId: revoke_key_v1_keys__key_id__delete parameters: - name: key_id in: path required: true schema: type: string title: Key Id responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/billing/summary: get: tags: - billing summary: Get Billing Summary operationId: get_billing_summary_v1_billing_summary_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BillingSummaryResponse' /v1/billing/checkout/stripe: post: tags: - billing summary: Create Stripe Checkout operationId: create_stripe_checkout_v1_billing_checkout_stripe_post requestBody: content: application/json: schema: $ref: '#/components/schemas/StripeCheckoutRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StripeCheckoutResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/billing/portal/stripe: post: tags: - billing summary: Create Stripe Portal operationId: create_stripe_portal_v1_billing_portal_stripe_post requestBody: content: application/json: schema: $ref: '#/components/schemas/StripePortalRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StripePortalResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/billing/refresh/stripe: post: tags: - billing summary: Refresh Stripe Billing operationId: refresh_stripe_billing_v1_billing_refresh_stripe_post responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StripeRefreshResponse' /v1/billing/webhooks/stripe: post: tags: - billing summary: Stripe Webhook operationId: stripe_webhook_v1_billing_webhooks_stripe_post parameters: - name: Stripe-Signature in: header required: false schema: anyOf: - type: string - type: 'null' title: Stripe-Signature responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StripeWebhookResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/receipt: post: tags: - Receipt summary: Generate a signed Hilt receipt description: 'Generate a cryptographically signed Hilt receipt for a Solana transaction. **Idempotent:** The same `tx_sig` always returns the same receipt. Stored immutably in Postgres + Cloudflare R2. Ed25519 signed by the Hilt server key.' operationId: post_receipt_v1_receipt_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ReceiptRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceiptResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/receipt/{receipt_id}: get: tags: - Receipt summary: Retrieve a receipt by ID description: Retrieve the full signed receipt JSON. Auth required. operationId: get_receipt_v1_receipt__receipt_id__get parameters: - name: receipt_id in: path required: true schema: type: string title: Receipt Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceiptResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/receipt/{receipt_id}/public: get: tags: - Receipt summary: Public receipt proof detail operationId: get_public_receipt_v1_receipt__receipt_id__public_get parameters: - name: receipt_id in: path required: true schema: type: string title: Receipt Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PublicReceiptResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/receipt/{receipt_id}/verify: get: tags: - Receipt summary: Publicly verify a receipt's cryptographic signature description: '**Public endpoint — no authentication required.** Re-computes the SHA-256 hash of the receipt JSON and verifies the Ed25519 signature. Returns verification result usable by auditors and third parties.' operationId: verify_receipt_v1_receipt__receipt_id__verify_get parameters: - name: receipt_id in: path required: true schema: type: string title: Receipt Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VerifyReceiptResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/receipt/{receipt_id}/pdf: get: tags: - Receipt summary: Public PDF receipt proof operationId: get_receipt_pdf_v1_receipt__receipt_id__pdf_get parameters: - name: receipt_id in: path required: true schema: type: string title: Receipt Id responses: '200': description: Rendered receipt proof. content: application/pdf: schema: type: string format: binary '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/receipt/{receipt_id}/pdf/private: get: tags: - Receipt summary: Authenticated PDF receipt export operationId: get_authenticated_receipt_pdf_v1_receipt__receipt_id__pdf_private_get parameters: - name: receipt_id in: path required: true schema: type: string title: Receipt Id responses: '200': description: Rendered authenticated receipt. content: application/pdf: schema: type: string format: binary '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/receipts: get: tags: - Receipt summary: List receipts description: Paginated list of receipts for the authenticated user. operationId: list_receipts_v1_receipts_get parameters: - name: page in: query required: false schema: type: integer minimum: 1 description: Page number default: 1 title: Page description: Page number - name: per_page in: query required: false schema: type: integer maximum: 100 minimum: 1 description: Results per page default: 20 title: Per Page description: Results per page - name: wallet in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by wallet address title: Wallet description: Filter by wallet address - name: q in: query required: false schema: anyOf: - type: string - type: 'null' description: Search by tx, receipt id, product, or invoice metadata title: Q description: Search by tx, receipt id, product, or invoice metadata - name: product_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by product title: Product Id description: Filter by product responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceiptListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/receipts/export.csv: get: tags: - Receipt summary: Export authenticated receipt ledger CSV description: Authenticated CSV export for merchant-owned receipt and invoice records. operationId: export_receipts_csv_v1_receipts_export_csv_get parameters: - name: wallet in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by wallet address title: Wallet description: Filter by wallet address - name: q in: query required: false schema: anyOf: - type: string - type: 'null' description: Search by tx, receipt id, product, or invoice metadata title: Q description: Search by tx, receipt id, product, or invoice metadata - name: product_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by product title: Product Id description: Filter by product responses: '200': description: Receipt ledger export. content: text/csv: schema: type: string format: binary '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/receipt/{receipt_id}/invoice-metadata: patch: tags: - Receipt summary: Save merchant invoice metadata for a receipt operationId: update_receipt_invoice_metadata_v1_receipt__receipt_id__invoice_metadata_patch parameters: - name: receipt_id in: path required: true schema: type: string title: Receipt Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReceiptInvoiceMetadataRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceiptUpdateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/receipt/{receipt_id}/send-proof: post: tags: - Receipt summary: Email the public proof link for a receipt operationId: send_receipt_proof_v1_receipt__receipt_id__send_proof_post parameters: - name: receipt_id in: path required: true schema: type: string title: Receipt Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReceiptSendProofRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ReceiptProofEmailResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/support/tickets: post: tags: - Support - Support summary: Create support ticket operationId: create_ticket_v1_support_tickets_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateTicketRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SupportTicketCreateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - Support - Support summary: List user's tickets operationId: list_tickets_v1_support_tickets_get parameters: - name: status in: query required: false schema: anyOf: - type: string - type: 'null' title: Status - name: page in: query required: false schema: type: integer minimum: 1 default: 1 title: Page - name: per_page in: query required: false schema: type: integer maximum: 50 minimum: 1 default: 20 title: Per Page responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SupportTicketListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/support/tickets/{ticket_id}: get: tags: - Support - Support summary: Ticket thread operationId: get_ticket_v1_support_tickets__ticket_id__get parameters: - name: ticket_id in: path required: true schema: type: string title: Ticket Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SupportTicketThreadResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/support/tickets/{ticket_id}/message: post: tags: - Support - Support summary: Add message to ticket operationId: add_message_v1_support_tickets__ticket_id__message_post parameters: - name: ticket_id in: path required: true schema: type: string title: Ticket Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddMessageRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SupportMessageCreateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/webhooks/endpoints: get: tags: - webhooks summary: List webhook endpoints operationId: list_webhook_endpoints_v1_webhooks_endpoints_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WebhookEndpointListResponse' post: tags: - webhooks summary: Create webhook endpoint operationId: create_webhook_endpoint_v1_webhooks_endpoints_post requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookEndpointCreateRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WebhookEndpointCreateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/webhooks/endpoints/{endpoint_id}: patch: tags: - webhooks summary: Update webhook endpoint operationId: update_webhook_endpoint_v1_webhooks_endpoints__endpoint_id__patch parameters: - name: endpoint_id in: path required: true schema: type: string format: uuid title: Endpoint Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebhookEndpointUpdateRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WebhookEndpointResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - webhooks summary: Disable webhook endpoint operationId: disable_webhook_endpoint_v1_webhooks_endpoints__endpoint_id__delete parameters: - name: endpoint_id in: path required: true schema: type: string format: uuid title: Endpoint Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WebhookEndpointResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/webhooks/endpoints/{endpoint_id}/test: post: tags: - webhooks summary: Send a signed test webhook event operationId: test_webhook_endpoint_v1_webhooks_endpoints__endpoint_id__test_post parameters: - name: endpoint_id in: path required: true schema: type: string format: uuid title: Endpoint Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebhookTestEventRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WebhookTestResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/webhooks/deliveries: get: tags: - webhooks summary: List webhook deliveries operationId: list_webhook_deliveries_v1_webhooks_deliveries_get parameters: - name: endpoint_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Endpoint Id - name: status in: query required: false schema: anyOf: - type: string - type: 'null' title: Status - name: page in: query required: false schema: type: integer minimum: 1 default: 1 title: Page - name: per_page in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 20 title: Per Page responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WebhookDeliveriesResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/webhooks/deliveries/{delivery_id}/replay: post: tags: - webhooks summary: Replay a webhook delivery operationId: replay_owned_webhook_delivery_v1_webhooks_deliveries__delivery_id__replay_post parameters: - name: delivery_id in: path required: true schema: type: integer title: Delivery Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WebhookDeliveryResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/webhooks/timeline: get: tags: - webhooks summary: View webhook event timeline for a payment or membership operationId: webhook_timeline_v1_webhooks_timeline_get parameters: - name: payment_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Payment Id - name: membership_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Membership Id - name: limit in: query required: false schema: type: integer maximum: 120 minimum: 1 default: 40 title: Limit responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WebhookTimelineResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/webhooks/events: get: tags: - webhooks summary: List emitted webhook events operationId: list_webhook_events_v1_webhooks_events_get parameters: - name: event_type in: query required: false schema: anyOf: - type: string - type: 'null' title: Event Type - name: page in: query required: false schema: type: integer minimum: 1 default: 1 title: Page - name: per_page in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 20 title: Per Page responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/WebhookEventsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/integrations/health: get: tags: - integrations summary: Check integration connection health operationId: integration_health_v1_integrations_health_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/IntegrationHealthResponse' /v1/integrations/events: get: tags: - integrations summary: List emitted events for integrations operationId: list_integration_events_v1_integrations_events_get parameters: - name: event_type in: query required: false schema: anyOf: - type: string - type: 'null' title: Event Type - name: page in: query required: false schema: type: integer minimum: 1 default: 1 title: Page - name: per_page in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 20 title: Per Page - name: limit in: query required: false schema: anyOf: - type: integer maximum: 100 minimum: 1 - type: 'null' title: Limit responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/IntegrationEventsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/integrations/zapier/hooks: post: tags: - integrations summary: Subscribe a Zapier REST Hook operationId: subscribe_zapier_hook_v1_integrations_zapier_hooks_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ZapierHookSubscribeRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ZapierHookResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/integrations/zapier/hooks/{endpoint_id}: delete: tags: - integrations summary: Unsubscribe a Zapier REST Hook operationId: unsubscribe_zapier_hook_v1_integrations_zapier_hooks__endpoint_id__delete parameters: - name: endpoint_id in: path required: true schema: type: string format: uuid title: Endpoint Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ZapierHookResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/testing/scenarios: get: tags: - testing summary: List supported sandbox scenarios operationId: sandbox_scenarios_v1_testing_scenarios_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SandboxScenariosResponse' /v1/testing/sessions: post: tags: - testing summary: Create a simulated Hilt sandbox session operationId: create_sandbox_session_v1_testing_sessions_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SandboxSessionCreateRequest' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TestingSandboxCreateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - testing summary: List recent simulated sandbox sessions operationId: list_sandbox_sessions_v1_testing_sessions_get parameters: - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 20 title: Limit responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TestingSandboxListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/testing/sessions/{session_id}: get: tags: - testing summary: Get a simulated sandbox session operationId: get_sandbox_session_v1_testing_sessions__session_id__get parameters: - name: session_id in: path required: true schema: type: string title: Session Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TestingSandboxDetailResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/agent-bootstrap: post: tags: - hilt-pay-api summary: Create a sandbox Hilt Pay API setup intent for an agent operationId: create_agent_bootstrap_v1_access_agent_bootstrap_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessAgentBootstrapRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessAgentBootstrapResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/agent-bootstrap/{setup_intent_id}/status: post: tags: - hilt-pay-api summary: Check a Hilt Pay API agent setup intent operationId: get_agent_bootstrap_status_v1_access_agent_bootstrap__setup_intent_id__status_post parameters: - name: setup_intent_id in: path required: true schema: type: string format: uuid title: Setup Intent Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessAgentSetupStatusRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessAgentBootstrapResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/agent-bootstrap/{setup_intent_id}/manifest: post: tags: - hilt-pay-api summary: Attach and evaluate an agent setup manifest operationId: submit_agent_bootstrap_manifest_v1_access_agent_bootstrap__setup_intent_id__manifest_post parameters: - name: setup_intent_id in: path required: true schema: type: string format: uuid title: Setup Intent Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessAgentSetupManifestRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessAgentBootstrapResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/agent-bootstrap/{setup_intent_id}/approve: post: tags: - hilt-pay-api summary: Approve an agent setup intent and optionally issue a live Hilt Pay API key operationId: approve_agent_bootstrap_v1_access_agent_bootstrap__setup_intent_id__approve_post parameters: - name: setup_intent_id in: path required: true schema: type: string format: uuid title: Setup Intent Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessAgentSetupApproveRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessAgentBootstrapResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/rails: get: tags: - hilt-pay-api summary: List Hilt Pay API rails operationId: list_access_rails_v1_access_rails_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessRailsResponse' /v1/access/rail-settings: get: tags: - hilt-pay-api summary: List merchant Hilt Pay API rail settings operationId: list_rail_settings_v1_access_rail_settings_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessRailSettingsResponse' /v1/access/rail-settings/{rail_id}: put: tags: - hilt-pay-api summary: Configure a merchant Hilt Pay API rail operationId: update_rail_setting_v1_access_rail_settings__rail_id__put parameters: - name: rail_id in: path required: true schema: type: string title: Rail Id - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessRailSettingUpdateRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessRailSettingResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/native-subscriptions/{authorization_id}: get: tags: - hilt-pay-api summary: Read a Solana native subscription authorization operationId: read_native_subscription_v1_access_native_subscriptions__authorization_id__get parameters: - name: authorization_id in: path required: true schema: type: string title: Authorization Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/NativeSubscriptionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/native-subscriptions/{authorization_id}/cancel-intent: post: tags: - hilt-pay-api summary: Create a buyer cancellation intent operationId: create_native_subscription_cancel_intent_v1_access_native_subscriptions__authorization_id__cancel_intent_post parameters: - name: authorization_id in: path required: true schema: type: string title: Authorization Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NativeSubscriptionCancelIntentRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/NativeSubscriptionCancelResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/native-subscriptions/{authorization_id}/cancel-confirm: post: tags: - hilt-pay-api summary: Confirm native subscription cancellation proof operationId: confirm_native_subscription_cancel_v1_access_native_subscriptions__authorization_id__cancel_confirm_post parameters: - name: authorization_id in: path required: true schema: type: string title: Authorization Id - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NativeSubscriptionCancelConfirmRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/NativeSubscriptionCancelResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/apps: post: tags: - hilt-pay-api summary: Create a Hilt Pay API app operationId: create_app_v1_access_apps_post parameters: - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessAppCreateRequest' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessAppCreateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/products: post: tags: - hilt-pay-api summary: Create a Hilt Pay API product operationId: create_product_v1_access_products_post parameters: - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessProductCreateRequest' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessProductCreateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/setup/readiness: get: tags: - hilt-pay-api summary: Inspect agent setup readiness for Hilt Pay API operationId: setup_readiness_v1_access_setup_readiness_get parameters: - name: access_app_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Access App Id - name: product_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Product Id - name: external_product_id in: query required: false schema: anyOf: - type: string maxLength: 180 - type: 'null' title: External Product Id - name: mode in: query required: false schema: type: string default: live title: Mode responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessSetupReadinessResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/products/available-rails: get: tags: - hilt-pay-api summary: List available rails for a Hilt Pay API product by lookup operationId: product_available_rails_by_lookup_v1_access_products_available_rails_get parameters: - name: product_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Product Id - name: external_product_id in: query required: false schema: anyOf: - type: string maxLength: 180 - type: 'null' title: External Product Id - name: mode in: query required: false schema: type: string default: live title: Mode responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessProductRailsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/products/{product_id}/available-rails: get: tags: - hilt-pay-api summary: List available rails for a Hilt Pay API product operationId: product_available_rails_v1_access_products__product_id__available_rails_get parameters: - name: product_id in: path required: true schema: type: string format: uuid title: Product Id - name: mode in: query required: false schema: type: string default: live title: Mode responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessProductRailsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/payment-sessions: post: tags: - hilt-pay-api summary: Create an access payment session operationId: create_payment_session_v1_access_payment_sessions_post parameters: - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessPaymentSessionCreateRequest' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessPaymentSessionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/metered-sessions: post: tags: - hilt-pay-api summary: Create an MPP metered payment session operationId: create_mpp_metered_session_v1_access_metered_sessions_post parameters: - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessMeteredSessionCreateRequest' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessMeteredSessionCreateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/metered-sessions/{session_id}/authorize: post: tags: - hilt-pay-api summary: Open, update, commit, or close an MPP metered session operationId: authorize_mpp_metered_session_v1_access_metered_sessions__session_id__authorize_post parameters: - name: session_id in: path required: true schema: type: string title: Session Id - name: Authorization in: header required: false schema: anyOf: - type: string - type: 'null' title: Authorization responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessMeteredSessionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/metered-sessions/{session_id}/deliveries: post: tags: - hilt-pay-api summary: Reserve metered delivery against an open MPP session operationId: create_mpp_metered_delivery_v1_access_metered_sessions__session_id__deliveries_post parameters: - name: session_id in: path required: true schema: type: string title: Session Id - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessMeteredDeliveryCreateRequest' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessMeteredDeliveryResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/metered-sessions/{session_id}/commits: post: tags: - hilt-pay-api summary: Commit a reserved delivery with its cumulative MPP voucher operationId: commit_mpp_metered_delivery_v1_access_metered_sessions__session_id__commits_post parameters: - name: session_id in: path required: true schema: type: string title: Session Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessMeteredCommitRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessMeteredCommitResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/metered-sessions/{session_id}/settle: post: tags: - hilt-pay-api summary: Settle an open MPP session at its highest verified voucher operationId: settle_mpp_metered_session_v1_access_metered_sessions__session_id__settle_post parameters: - name: session_id in: path required: true schema: type: string title: Session Id - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessMeteredSessionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/metered-sessions/{session_id}: get: tags: - hilt-pay-api summary: Read an MPP metered session and its delivery evidence operationId: read_mpp_metered_session_v1_access_metered_sessions__session_id__get parameters: - name: session_id in: path required: true schema: type: string title: Session Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessMeteredSessionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/sandbox/payment-sessions: post: tags: - hilt-pay-api summary: Create a sandbox Hilt Pay API payment session operationId: create_sandbox_payment_session_v1_access_sandbox_payment_sessions_post parameters: - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessSandboxPaymentSessionCreateRequest' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessSandboxSessionCreateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/sandbox/payment-sessions/{sandbox_session_id}/confirm: post: tags: - hilt-pay-api summary: Confirm a sandbox Hilt Pay API payment proof operationId: confirm_sandbox_payment_session_v1_access_sandbox_payment_sessions__sandbox_session_id__confirm_post parameters: - name: sandbox_session_id in: path required: true schema: type: string format: uuid title: Sandbox Session Id - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessSandboxPaymentSessionConfirmRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessSandboxSessionConfirmResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/payment-proofs: post: tags: - hilt-pay-api summary: Submit a Hilt Pay API rail payment proof operationId: submit_payment_proof_v1_access_payment_proofs_post parameters: - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessPaymentProofSubmitRequest' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessPaymentProofResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/x402/settle: post: tags: - hilt-pay-api summary: Verify and settle an x402 V2 payment operationId: settle_x402_payment_v1_access_x402_settle_post parameters: - name: PAYMENT-SIGNATURE in: header required: false schema: anyOf: - type: string - type: 'null' title: Payment-Signature - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessX402SettleRequest' responses: '200': description: Verified settlement with payment proof, receipt, entitlement, and x402 payment response. content: application/json: schema: $ref: '#/components/schemas/AccessX402SettleResponse' headers: PAYMENT-RESPONSE: description: Base64-encoded x402 V2 settlement response for the buyer. schema: type: string '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/entitlements/check: post: tags: - hilt-pay-api summary: Check access entitlement operationId: check_entitlement_v1_access_entitlements_check_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessEntitlementCheckRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessEntitlementCheckResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/entitlements/consume: post: tags: - hilt-pay-api summary: Atomically consume metered entitlement usage operationId: consume_entitlement_usage_v1_access_entitlements_consume_post parameters: - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessEntitlementConsumeRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessEntitlementConsumeResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/entitlements/{entitlement_id}: get: tags: - hilt-pay-api summary: Get an access entitlement operationId: get_entitlement_v1_access_entitlements__entitlement_id__get parameters: - name: entitlement_id in: path required: true schema: type: string format: uuid title: Entitlement Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessEntitlementResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/access/billing/entitlement: get: tags: - hilt-pay-api summary: Get current Hilt Pay API billing entitlement operationId: get_billing_entitlement_v1_access_billing_entitlement_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessBillingEntitlementResponse' /v1/access/billing/checkout/stripe: post: tags: - hilt-pay-api summary: Retired Hilt Pay API subscription checkout operationId: create_hilt_pay_api_stripe_checkout_v1_access_billing_checkout_stripe_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessBillingStripeCheckoutRequest' required: true responses: '410': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true /v1/access/webhooks: post: tags: - hilt-pay-api summary: Create a webhook endpoint for Hilt Pay API operationId: create_webhook_v1_access_webhooks_post parameters: - name: Idempotency-Key in: header required: true schema: type: string title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessWebhookCreateRequest' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccessWebhookCreateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/broadcast: post: tags: - checkout summary: Record Payment Broadcast operationId: record_payment_broadcast_v1_pay_broadcast_post requestBody: content: application/json: schema: $ref: '#/components/schemas/BroadcastRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BroadcastResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/automatic-renew/setup: post: tags: - checkout summary: Automatic Renew Setup operationId: automatic_renew_setup_v1_pay_automatic_renew_setup_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AutomaticRenewSetupRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AutomaticRenewSetupResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/identity/start: post: tags: - checkout summary: Start Checkout Identity Handshake operationId: start_checkout_identity_handshake_v1_pay_identity_start_post requestBody: content: application/json: schema: $ref: '#/components/schemas/IdentityHandshakeStartRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/IdentityHandshakeStartResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/identity/complete: post: tags: - checkout summary: Complete Checkout Identity Handshake operationId: complete_checkout_identity_handshake_v1_pay_identity_complete_post requestBody: content: application/json: schema: $ref: '#/components/schemas/IdentityHandshakeCompleteRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/IdentityHandshakeCompleteResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/phantom/connect/callback: post: tags: - checkout summary: Phantom Connect Callback operationId: phantom_connect_callback_v1_pay_phantom_connect_callback_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PhantomConnectCallbackRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PhantomConnectCallbackResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/phantom/message-url: post: tags: - checkout summary: Phantom Message Url operationId: phantom_message_url_v1_pay_phantom_message_url_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PhantomMessageUrlRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PhantomDeeplinkResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/phantom/renewal-message-url: post: tags: - checkout summary: Phantom Renewal Message Url operationId: phantom_renewal_message_url_v1_pay_phantom_renewal_message_url_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PhantomRenewalMessageUrlRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PhantomDeeplinkResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/phantom/message/callback: post: tags: - checkout summary: Phantom Message Callback operationId: phantom_message_callback_v1_pay_phantom_message_callback_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PhantomMessageCallbackRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PhantomMessageCallbackResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/phantom/renewal-message/callback: post: tags: - checkout summary: Phantom Renewal Message Callback operationId: phantom_renewal_message_callback_v1_pay_phantom_renewal_message_callback_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PhantomRenewalMessageCallbackRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PhantomRenewalMessageCallbackResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/phantom/transaction-url: post: tags: - checkout summary: Phantom Transaction Url operationId: phantom_transaction_url_v1_pay_phantom_transaction_url_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PhantomTransactionUrlRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PhantomDeeplinkResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/phantom/transaction/callback: post: tags: - checkout summary: Phantom Transaction Callback operationId: phantom_transaction_callback_v1_pay_phantom_transaction_callback_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PhantomTransactionCallbackRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PhantomTransactionCallbackResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay/confirm: post: tags: - checkout summary: Confirm Payment operationId: confirm_payment_v1_pay_confirm_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfirmRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConfirmResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/connectors/grok/authorization: get: tags: - Hilt PayMe Connector summary: Read Grok Authorization operationId: read_grok_authorization_v1_connectors_grok_authorization_get parameters: - name: request in: query required: true schema: type: string minLength: 20 maxLength: 8000 title: Request responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConnectorAuthorizationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - Hilt PayMe Connector summary: Approve Grok Authorization operationId: approve_grok_authorization_v1_connectors_grok_authorization_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectorAuthorizationComplete' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConnectorAuthorizationRedirectResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/connector-connections: get: tags: - Hilt PayMe Connector summary: Read Pay Me Connector Connections operationId: read_pay_me_connector_connections_v1_pay_me_connector_connections_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConnectorConnectionListResponse' /v1/pay-me/connector-connections/{connection_id}: delete: tags: - Hilt PayMe Connector summary: Disconnect Pay Me Connector operationId: disconnect_pay_me_connector_v1_pay_me_connector_connections__connection_id__delete parameters: - name: connection_id in: path required: true schema: type: string format: uuid title: Connection Id responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/payment-requests: post: tags: - Hilt PayMe Connector summary: Create Pay Me Payment Request operationId: create_pay_me_payment_request_v1_pay_me_payment_requests_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRequestCreate' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaymentRequestEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/payment-requests/{public_id}: get: tags: - Hilt PayMe Connector summary: Read Pay Me Payment Request operationId: read_pay_me_payment_request_v1_pay_me_payment_requests__public_id__get parameters: - name: public_id in: path required: true schema: type: string title: Public Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaymentRequestEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/payment-intents/{public_id}: get: tags: - Hilt PayMe Connector summary: Read Pay Me Payment Intent operationId: read_pay_me_payment_intent_v1_pay_me_payment_intents__public_id__get parameters: - name: public_id in: path required: true schema: type: string title: Public Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaymentIntentEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/session: get: tags: - pay-me summary: Read the authenticated X identity and Hilt PayMe profile operationId: read_pay_me_session_v1_pay_me_session_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeSessionResponse' /v1/pay-me/security: get: tags: - pay-me summary: Read PayMe receiving-wallet security status operationId: read_pay_me_security_v1_pay_me_security_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeSecurityStatusResponse' /v1/pay-me/security/authenticator/setup: post: tags: - pay-me summary: Start PayMe authenticator enrollment operationId: start_pay_me_authenticator_setup_v1_pay_me_security_authenticator_setup_post responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeAuthenticatorSetupResponse' /v1/pay-me/security/authenticator/enrollments/{enrollment_id}: get: tags: - pay-me summary: Read a short-lived PayMe authenticator wallet approval operationId: read_pay_me_authenticator_enrollment_v1_pay_me_security_authenticator_enrollments__enrollment_id__get parameters: - name: enrollment_id in: path required: true schema: type: string title: Enrollment Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeAuthenticatorEnrollmentResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/security/authenticator/enrollments/{enrollment_id}/signature: post: tags: - pay-me summary: Approve PayMe authenticator setup with the current wallet operationId: approve_pay_me_authenticator_wallet_v1_pay_me_security_authenticator_enrollments__enrollment_id__signature_post parameters: - name: enrollment_id in: path required: true schema: type: string title: Enrollment Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PayMeAuthenticatorWalletSignature' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeWalletSignatureResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/security/authenticator/enrollments/{enrollment_id}/status: get: tags: - pay-me summary: Read current-wallet approval status for PayMe authenticator setup operationId: read_pay_me_authenticator_enrollment_status_v1_pay_me_security_authenticator_enrollments__enrollment_id__status_get parameters: - name: enrollment_id in: path required: true schema: type: string title: Enrollment Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeAuthenticatorEnrollmentStatusResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/security/authenticator/confirm: post: tags: - pay-me summary: Confirm PayMe authenticator enrollment operationId: confirm_pay_me_authenticator_setup_v1_pay_me_security_authenticator_confirm_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PayMeAuthenticatorConfirm' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeAuthenticatorConfirmResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/profile: post: tags: - pay-me summary: Create or update a verified Hilt PayMe profile operationId: create_verified_pay_me_profile_v1_pay_me_profile_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PayMeProfileCreate' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeProfileEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/wallet-links: post: tags: - pay-me summary: Create a short-lived receiving-wallet verification link operationId: create_receiving_wallet_link_v1_pay_me_wallet_links_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PayMeWalletLinkCreate' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeWalletLinkEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/wallet-links/{wallet_link_id}: get: tags: - pay-me summary: Read a short-lived receiving-wallet verification link operationId: read_receiving_wallet_link_v1_pay_me_wallet_links__wallet_link_id__get parameters: - name: wallet_link_id in: path required: true schema: type: string title: Wallet Link Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeWalletLinkEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/wallet-links/{wallet_link_id}/prepare: post: tags: - pay-me summary: Prepare the exact receiving-wallet verification message operationId: prepare_receiving_wallet_link_v1_pay_me_wallet_links__wallet_link_id__prepare_post parameters: - name: wallet_link_id in: path required: true schema: type: string title: Wallet Link Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PayMeWalletLinkPrepare' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeWalletPrepareResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/wallet-links/{wallet_link_id}/signature: post: tags: - pay-me summary: Submit a receiving-wallet signature operationId: submit_receiving_wallet_signature_v1_pay_me_wallet_links__wallet_link_id__signature_post parameters: - name: wallet_link_id in: path required: true schema: type: string title: Wallet Link Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PayMeWalletLinkSignature' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeWalletSignatureResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/wallet-links/{wallet_link_id}/status: get: tags: - pay-me summary: Read receiving-wallet verification status operationId: read_receiving_wallet_link_status_v1_pay_me_wallet_links__wallet_link_id__status_get parameters: - name: wallet_link_id in: path required: true schema: type: string title: Wallet Link Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeWalletLinkEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/wallet-links/{wallet_link_id}/complete: post: tags: - pay-me summary: Confirm a verified receiving wallet and publish the PayMe profile operationId: complete_receiving_wallet_link_v1_pay_me_wallet_links__wallet_link_id__complete_post parameters: - name: wallet_link_id in: path required: true schema: type: string title: Wallet Link Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeProfileEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/orders: post: tags: - pay-me summary: Create an atomic PayMe payment order operationId: create_pay_me_order_v1_pay_me_orders_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PayMeOrderCreate' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeOrderEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/orders/{public_id}: get: tags: - pay-me summary: Read a PayMe payment order operationId: read_pay_me_order_v1_pay_me_orders__public_id__get parameters: - name: public_id in: path required: true schema: type: string title: Public Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeOrderEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/orders/{public_id}/confirm: post: tags: - pay-me summary: Confirm an atomic PayMe payment order operationId: confirm_pay_me_order_v1_pay_me_orders__public_id__confirm_post parameters: - name: public_id in: path required: true schema: type: string title: Public Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PayMeOrderConfirm' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeOrderEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/payments: post: tags: - pay-me summary: Pay a verified Hilt PayMe recipient through MPP description: 'Resolve a verified X handle and settle an exact SOL or Solana USDC payment. The first request returns an MPP HTTP 402 challenge. Retry the same request with Authorization: Payment to settle the recipient amount and Hilt''s payer-funded 2% fee in one Solana transaction. No payer account or API key is required.' operationId: create_or_settle_pay_me_agent_payment_v1_pay_me_payments_post parameters: - name: Idempotency-Key in: header required: false schema: type: string maxLength: 128 default: '' title: Idempotency-Key requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PayMeAgentPaymentCreate' responses: '200': description: The PayMe payment is settled and the Hilt receipt is available. content: application/json: schema: $ref: '#/components/schemas/PayMeAgentPaymentEnvelope' headers: Payment-Receipt: description: Machine Payments Protocol settlement receipt. schema: type: string X-Payment-Settlement-Signature: description: Finalized Solana transaction signature. schema: type: string '402': description: MPP payment authorization is required. headers: WWW-Authenticate: description: Machine Payments Protocol charge challenge. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PayMeAgentPaymentRequiredResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/payments/{public_id}: get: tags: - pay-me summary: Read a PayMe MPP payment and receipt operationId: read_pay_me_agent_payment_v1_pay_me_payments__public_id__get parameters: - name: public_id in: path required: true schema: type: string title: Public Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeAgentPaymentEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/{x_handle}: get: tags: - pay-me summary: Resolve a verified Hilt PayMe profile operationId: resolve_pay_me_profile_v1_pay_me__x_handle__get parameters: - name: x_handle in: path required: true schema: type: string title: X Handle responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeProfileEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/pay-me/{x_handle}/checkouts: post: tags: - pay-me summary: Create a payer-authorized checkout from a Hilt PayMe profile operationId: create_pay_me_profile_checkout_v1_pay_me__x_handle__checkouts_post parameters: - name: x_handle in: path required: true schema: type: string title: X Handle requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PayMeCheckoutCreate' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayMeCheckoutEnvelope' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/products: post: tags: - products summary: Create a B2C payment product operationId: api_create_product_v1_products_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateProductRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProductResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - products summary: List my products operationId: api_list_products_v1_products_get parameters: - name: status in: query required: false schema: anyOf: - type: string - type: 'null' title: Status - name: product_type in: query required: false schema: anyOf: - type: string - type: 'null' title: Product Type - name: limit in: query required: false schema: type: integer maximum: 200 minimum: 1 default: 50 title: Limit - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProductListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/products/p/{slug}: get: tags: - products summary: View product (public) description: Public product view — strips sensitive fields. operationId: api_view_product_public_v1_products_p__slug__get parameters: - name: slug in: path required: true schema: type: string title: Slug responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProductResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/products/p/{slug}/connect: post: tags: - products summary: Initiate a checkout session (public) description: "Canonical checkout session initializer.\n\nCreates one payment session / intent record and returns:\n - payment_id — the canonical ID used by both the browser signer path and\n the Phantom mobile path throughout the checkout flow\n - phantom_mobile.connect_url — Phantom Universal Link for mobile app-switch\n signing (present only if the server has a\n dapp key configured)\n\nBoth execution paths (browser Phantom and mobile Phantom) share the same\npayment_id and converge on the same backend confirmation + delivery pipeline.\n\nIdentity / customer reference fields are optional at session-creation time.\nThey must be provided by payment time (via the confirm or sign endpoints)\nfor products that enforce membership identity.\n\nNo API key required." operationId: api_connect_payment_v1_products_p__slug__connect_post parameters: - name: slug in: path required: true schema: type: string title: Slug requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CheckoutPaymentSessionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/products/p/{slug}/resolve-handoff: post: tags: - products summary: Resolve a signed buyer handoff (public) operationId: api_resolve_checkout_handoff_v1_products_p__slug__resolve_handoff_post parameters: - name: slug in: path required: true schema: type: string title: Slug requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CheckoutHandoffResolveRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CheckoutHandoffResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/products/{product_id}/payments: get: tags: - products summary: List payments for a product operationId: api_list_payments_v1_products__product_id__payments_get parameters: - name: product_id in: path required: true schema: type: string format: uuid title: Product Id - name: status in: query required: false schema: anyOf: - type: string - type: 'null' title: Status - name: limit in: query required: false schema: type: integer maximum: 200 minimum: 1 default: 50 title: Limit - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaymentListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/products/{product_id}/analytics: get: tags: - products summary: Payment analytics for a product operationId: api_product_analytics_v1_products__product_id__analytics_get parameters: - name: product_id in: path required: true schema: type: string format: uuid title: Product Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProductAnalyticsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/products/{product_id}: get: tags: - products summary: Get product by ID operationId: api_get_product_v1_products__product_id__get parameters: - name: product_id in: path required: true schema: type: string format: uuid title: Product Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProductResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - products summary: Update a product operationId: api_update_product_v1_products__product_id__patch parameters: - name: product_id in: path required: true schema: type: string format: uuid title: Product Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateProductRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProductResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - products summary: Archive a product operationId: api_archive_product_v1_products__product_id__delete parameters: - name: product_id in: path required: true schema: type: string format: uuid title: Product Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProductResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/products/{product_id}/handoff-link: post: tags: - products summary: Create a signed buyer checkout link operationId: api_create_checkout_handoff_link_v1_products__product_id__handoff_link_post parameters: - name: product_id in: path required: true schema: type: string format: uuid title: Product Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CheckoutHandoffCreateRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CheckoutHandoffResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/payments/{payment_id}: get: tags: - products summary: Poll payment status (public) description: Customer polls after signing in Phantom. Safe field subset returned. operationId: api_payment_status_v1_payments__payment_id__get parameters: - name: payment_id in: path required: true schema: type: string title: Payment Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PublicPaymentStatusResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/memberships: get: tags: - memberships summary: List memberships operationId: api_list_memberships_v1_memberships_get parameters: - name: product_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Product Id - name: status in: query required: false schema: anyOf: - type: string - type: 'null' title: Status - name: platform in: query required: false schema: anyOf: - type: string - type: 'null' title: Platform - name: q in: query required: false schema: anyOf: - type: string - type: 'null' title: Q - name: limit in: query required: false schema: type: integer maximum: 200 minimum: 1 default: 50 title: Limit - name: offset in: query required: false schema: type: integer minimum: 0 default: 0 title: Offset responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MembershipListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/memberships/lookup: get: tags: - memberships summary: Lookup memberships by wallet, identity, or transaction operationId: api_lookup_memberships_v1_memberships_lookup_get parameters: - name: product_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Product Id - name: wallet in: query required: false schema: anyOf: - type: string - type: 'null' title: Wallet - name: identity in: query required: false schema: anyOf: - type: string - type: 'null' title: Identity - name: tx_signature in: query required: false schema: anyOf: - type: string - type: 'null' title: Tx Signature responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MembershipListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/memberships/renewal-intelligence: get: tags: - memberships summary: Renewal cohorts, reminders, and reporting operationId: api_membership_renewal_intelligence_v1_memberships_renewal_intelligence_get parameters: - name: window_days in: query required: false schema: type: integer maximum: 60 minimum: 1 default: 7 title: Window Days - name: limit in: query required: false schema: type: integer maximum: 200 minimum: 1 default: 60 title: Limit responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MembershipRenewalIntelligenceResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/memberships/{membership_id}: get: tags: - memberships summary: Get membership by ID operationId: api_get_membership_v1_memberships__membership_id__get parameters: - name: membership_id in: path required: true schema: type: string title: Membership Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MembershipDetailResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/memberships/{membership_id}/notes: patch: tags: - memberships summary: Save merchant notes for a membership operationId: api_update_membership_notes_v1_memberships__membership_id__notes_patch parameters: - name: membership_id in: path required: true schema: type: string title: Membership Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MembershipNotesRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MembershipDetailResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/memberships/{membership_id}/profile: patch: tags: - memberships summary: Update member display details operationId: api_update_membership_profile_v1_memberships__membership_id__profile_patch parameters: - name: membership_id in: path required: true schema: type: string title: Membership Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MembershipProfileRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MembershipDetailResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/memberships/{membership_id}/gift: post: tags: - memberships summary: Gift extra access time to a member operationId: api_gift_membership_extension_v1_memberships__membership_id__gift_post parameters: - name: membership_id in: path required: true schema: type: string title: Membership Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MembershipGiftRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MembershipDetailResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/memberships/{membership_id}/retry-delivery: post: tags: - memberships summary: Retry membership access delivery operationId: api_retry_membership_delivery_v1_memberships__membership_id__retry_delivery_post parameters: - name: membership_id in: path required: true schema: type: string title: Membership Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MembershipDeliveryResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/memberships/{membership_id}/delivery-diagnostics: get: tags: - memberships summary: Inspect Telegram or Discord automation for a membership operationId: api_membership_delivery_diagnostics_v1_memberships__membership_id__delivery_diagnostics_get parameters: - name: membership_id in: path required: true schema: type: string title: Membership Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MembershipDeliveryDiagnosticsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/memberships/{membership_id}/delivery-support-ticket: post: tags: - memberships summary: Open or reuse a support ticket for a delivery issue operationId: api_membership_delivery_support_ticket_v1_memberships__membership_id__delivery_support_ticket_post parameters: - name: membership_id in: path required: true schema: type: string title: Membership Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MembershipSupportTicketResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/memberships/{membership_id}/reactivation: get: tags: - memberships summary: Get renewal and reactivation links for a membership operationId: api_membership_reactivation_detail_v1_memberships__membership_id__reactivation_get parameters: - name: membership_id in: path required: true schema: type: string title: Membership Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MembershipReactivationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/checkout-domains: get: tags: - checkout-domains summary: List merchant checkout domain requests operationId: list_merchant_checkout_domains_v1_checkout_domains_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CheckoutDomainListResponse' post: tags: - checkout-domains summary: Request a merchant checkout domain operationId: request_merchant_checkout_domain_v1_checkout_domains_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckoutDomainRequest' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CheckoutDomainCreateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/agent-commerce/offer: get: operationId: getHiltPayApiMarketplaceOffer summary: Get the Hilt Pay API marketplace catalog description: Returns the canonical Hilt Pay API plans, free Agent Bootstrap route, and live purchase paths. tags: - Hilt Pay API security: [] responses: '200': description: Canonical Hilt Pay API marketplace offer content: application/json: schema: type: object additionalProperties: true example: service: Hilt Pay API suite: Hilt Pay agent: '@hiltcommerce' status: x402_enabled network: solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp interfaces: openapi: https://api.hilt.so/openapi.json mcp: https://api.hilt.so/mcp a2a: https://api.hilt.so/a2a/jsonrpc agentCard: https://api.hilt.so/.well-known/agent-card.json x402Activation: enabled: true network: solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp protectedResources: starter: https://api.hilt.so/v1/agent-commerce/plans/starter/activate growth: https://api.hilt.so/v1/agent-commerce/plans/growth/activate scale: https://api.hilt.so/v1/agent-commerce/plans/scale/activate category: agent-commerce tags: - x402 - Solana USDC - agent-commerce - checkout - receipts - entitlements - fulfillment positioning: 'Hilt Pay is payment-to-access infrastructure for stablecoin commerce: Solana USDC settlement, x402 protected-resource flows, receipts, entitlements, signed webhooks, subscription state, support context, and audit history.' paidRequestRuntime: version: hilt-x402-v2-metered-2026-07-21 sequence: - consume - challenge - pay - settle - consume - serve protocol: x402 V2 is the HTTP 402 protected-resource protocol shape. settlementRail: Solana USDC merchantServerRoutes: createPaymentSession: POST https://api.hilt.so/v1/access/payment-sessions settlePaymentSignature: POST https://api.hilt.so/v1/access/x402/settle consumeMeteredUsage: POST https://api.hilt.so/v1/access/entitlements/consume checkDurableAccess: POST https://api.hilt.so/v1/access/entitlements/check authority: Atomic consumption decides whether each metered request is served. Entitlement checks remain the authority for durable or time-based access. buyerBoundary: The buyer receives PAYMENT-REQUIRED and retries the protected resource with PAYMENT-SIGNATURE. The buyer never receives the merchant Hilt API key. serveRule: Serve billable work only after settlement and atomic consumption succeed. guide: https://docs.hilt.so/developers/agent-micropayments productStack: - id: hilt_pay_agent_bootstrap name: Hilt Pay Agent Bootstrap tier: sandbox price: amount: 0 currency: USD display: Free billing: free buyerMode: agent_can_start_sandbox_owner_approves_live endpoint: https://api.hilt.so/v1/access/agent-bootstrap deliverable: Sandbox setup intent, scoped sandbox key, proposed app/product/protected-resource manifest, readiness blockers, and owner approval handoff. - id: hilt_pay_api name: Hilt Pay API tier: core_infrastructure price: display: Free sandbox; live from $79/month billing: monthly_subscription buyerMode: agent_bootstraps_pays_and_receives_live_access pricingUrl: https://www.hilt.so/pricing?surface=api plans: - name: Sandbox monthlyUsd: 0 liveSettlement: false transactionFee: No live money - name: Starter monthlyUsd: 79 prepaidUsdc: 79 liveSettlement: true transactionFee: 1.00% endpoint: https://api.hilt.so/v1/agent-commerce/plans/starter/activate - name: Growth monthlyUsd: 349 prepaidUsdc: 349 liveSettlement: true transactionFee: 0.70% endpoint: https://api.hilt.so/v1/agent-commerce/plans/growth/activate - name: Scale monthlyUsd: 1250 prepaidUsdc: 1250 liveSettlement: true transactionFee: 0.45% endpoint: https://api.hilt.so/v1/agent-commerce/plans/scale/activate - name: Enterprise monthlyUsd: null liveSettlement: true transactionFee: Custom solanaUsdcPrepaidActivation: status: live marketplaceEndpoints: starter: https://api.hilt.so/v1/agent-commerce/plans/starter/activate growth: https://api.hilt.so/v1/agent-commerce/plans/growth/activate scale: https://api.hilt.so/v1/agent-commerce/plans/scale/activate hostedCheckoutEndpoint: https://api.hilt.so/v1/access/billing/checkout/solana-usdc acquisitionRoute: Create a free Agent Bootstrap setup intent before purchasing a live plan. accessPeriodDays: 30 automaticRenewal: false renewal: Create and pay a new purchase intent before the current access period ends. deliverable: Payment sessions, Solana USDC settlement, x402 requirements, receipts, entitlements, signed webhooks, subscription state, support context, and audit history through code. pricingPolicy: freeAcquisitionPath: Hilt Pay Agent Bootstrap sandbox setup intent liveApiPlans: Agent-native x402 V2 activation paid in Solana USDC, or Hilt account billing for Starter, Growth, and Scale. solanaUsdcPrepaidActivation: marketplaceEndpoints: starter: https://api.hilt.so/v1/agent-commerce/plans/starter/activate growth: https://api.hilt.so/v1/agent-commerce/plans/growth/activate scale: https://api.hilt.so/v1/agent-commerce/plans/scale/activate hostedCheckoutEndpoint: https://api.hilt.so/v1/access/billing/checkout/solana-usdc accessPeriodDays: 30 automaticRenewal: false prices: starter: 79 USDC growth: 349 USDC scale: 1,250 USDC rails: - Solana USDC for prepaid API plans - Solana USDC hosted checkout for Hilt account owners protocols: - x402 V2 for HTTP 402 protected-resource payment requirements upgradePath: - free Hilt Pay Agent Bootstrap sandbox setup - agent-native x402 V2 plan activation paid in Solana USDC, or Hilt account billing - Hilt Pay API Starter, Growth, Scale, or Enterprise with live key delivery /v1/agent-commerce/catalog: get: operationId: getHiltAgentCommerceCatalog summary: Get the canonical Hilt agent-commerce catalog tags: - Hilt Pay API security: [] responses: '200': description: Canonical product catalog content: application/json: schema: type: object additionalProperties: true /v1/agent-commerce/pricing: get: operationId: getHiltAgentCommercePricing summary: Get canonical Hilt agent-commerce pricing tags: - Hilt Pay API security: [] responses: '200': description: Canonical product and plan pricing content: application/json: schema: type: object additionalProperties: true /v1/agent-commerce/plans/starter/activate: post: operationId: activateHiltPayApiStarterWithX402 summary: Activate Hilt Pay API Starter description: Pays 79 USDC through x402, activates 30 days of Hilt Pay API starter, writes the Hilt receipt and billing entitlement, and returns a live API key. Create a free Agent Bootstrap setup intent first. tags: - Hilt Pay API security: [] x-payment-info: price: mode: fixed currency: USD amount: '79' protocols: - x402: {} requestBody: required: true content: application/json: schema: type: object properties: setup_intent_id: type: string format: uuid description: Setup intent returned by the free Hilt Pay Agent Bootstrap endpoint. setup_token: type: string minLength: 20 description: Secret setup token returned by Agent Bootstrap. delivery_claim: type: string minLength: 32 maxLength: 512 description: Buyer-generated random secret used to recover the live API key if the paid response is interrupted. required: - setup_intent_id - setup_token - delivery_claim additionalProperties: false example: setup_intent_id: 00000000-0000-4000-8000-000000000000 setup_token: hst_buyer_setup_token delivery_claim: buyer-generated-random-secret-at-least-32-characters responses: '200': description: Plan active and live API key delivered content: application/json: schema: type: object additionalProperties: true '202': description: Payment settled and activation recovery is running content: application/json: schema: type: object additionalProperties: true '402': description: Payment Required '409': description: The setup or current billing state does not permit this activation /v1/agent-commerce/plans/growth/activate: post: operationId: activateHiltPayApiGrowthWithX402 summary: Activate Hilt Pay API Growth description: Pays 349 USDC through x402, activates 30 days of Hilt Pay API growth, writes the Hilt receipt and billing entitlement, and returns a live API key. Create a free Agent Bootstrap setup intent first. tags: - Hilt Pay API security: [] x-payment-info: price: mode: fixed currency: USD amount: '349' protocols: - x402: {} requestBody: required: true content: application/json: schema: type: object properties: setup_intent_id: type: string format: uuid description: Setup intent returned by the free Hilt Pay Agent Bootstrap endpoint. setup_token: type: string minLength: 20 description: Secret setup token returned by Agent Bootstrap. delivery_claim: type: string minLength: 32 maxLength: 512 description: Buyer-generated random secret used to recover the live API key if the paid response is interrupted. required: - setup_intent_id - setup_token - delivery_claim additionalProperties: false example: setup_intent_id: 00000000-0000-4000-8000-000000000000 setup_token: hst_buyer_setup_token delivery_claim: buyer-generated-random-secret-at-least-32-characters responses: '200': description: Plan active and live API key delivered content: application/json: schema: type: object additionalProperties: true '202': description: Payment settled and activation recovery is running content: application/json: schema: type: object additionalProperties: true '402': description: Payment Required '409': description: The setup or current billing state does not permit this activation /v1/agent-commerce/plans/scale/activate: post: operationId: activateHiltPayApiScaleWithX402 summary: Activate Hilt Pay API Scale description: Pays 1250 USDC through x402, activates 30 days of Hilt Pay API scale, writes the Hilt receipt and billing entitlement, and returns a live API key. Create a free Agent Bootstrap setup intent first. tags: - Hilt Pay API security: [] x-payment-info: price: mode: fixed currency: USD amount: '1250' protocols: - x402: {} requestBody: required: true content: application/json: schema: type: object properties: setup_intent_id: type: string format: uuid description: Setup intent returned by the free Hilt Pay Agent Bootstrap endpoint. setup_token: type: string minLength: 20 description: Secret setup token returned by Agent Bootstrap. delivery_claim: type: string minLength: 32 maxLength: 512 description: Buyer-generated random secret used to recover the live API key if the paid response is interrupted. required: - setup_intent_id - setup_token - delivery_claim additionalProperties: false example: setup_intent_id: 00000000-0000-4000-8000-000000000000 setup_token: hst_buyer_setup_token delivery_claim: buyer-generated-random-secret-at-least-32-characters responses: '200': description: Plan active and live API key delivered content: application/json: schema: type: object additionalProperties: true '202': description: Payment settled and activation recovery is running content: application/json: schema: type: object additionalProperties: true '402': description: Payment Required '409': description: The setup or current billing state does not permit this activation /v1/agent-commerce/plans/claim: post: operationId: claimHiltPayApiMarketplaceKey summary: Claim a live Hilt Pay API key after marketplace activation description: Recovers live key delivery after a settled marketplace payment. Requires the purchase intent, Agent Bootstrap setup secret, and buyer-generated delivery claim. tags: - Hilt Pay API security: [] requestBody: required: true content: application/json: schema: type: object properties: purchase_intent_id: type: string format: uuid setup_intent_id: type: string format: uuid setup_token: type: string minLength: 20 delivery_claim: type: string minLength: 32 maxLength: 512 required: - purchase_intent_id - setup_intent_id - setup_token - delivery_claim additionalProperties: false responses: '200': description: Live API key delivered content: application/json: schema: type: object additionalProperties: true '409': description: Activation is still being reconciled /mcp: post: operationId: callHiltAgentGatewayMcp summary: Call the Hilt Agent Gateway over MCP Streamable HTTP description: Standards-based MCP endpoint exposing the canonical Hilt catalog, quote and bootstrap tools plus x402 V2 API-plan activation tools settled in Solana USDC. tags: - Agent Commerce security: [] requestBody: required: true content: application/json: schema: type: object additionalProperties: true responses: '200': description: MCP JSON-RPC response '202': description: MCP notification accepted /.well-known/agent-card.json: get: operationId: getHiltA2aAgentCard summary: Get the Hilt Pay A2A Agent Card tags: - Agent Commerce security: [] responses: '200': description: A2A Agent Card content: application/json: schema: type: object additionalProperties: true /.well-known/agent.json: get: operationId: getHiltA2aAgentCardLegacy summary: Get the Hilt Pay A2A Agent Card from the legacy discovery path description: Compatibility alias for registries that still discover A2A Agent Cards at /.well-known/agent.json. The standards-current A2A path remains /.well-known/agent-card.json. tags: - Agent Commerce security: [] responses: '200': description: A2A Agent Card content: application/json: schema: type: object additionalProperties: true /a2a/jsonrpc: post: operationId: callHiltA2aAgent summary: Call the Hilt Pay agent over A2A JSON-RPC tags: - Agent Commerce security: [] requestBody: required: true content: application/json: schema: type: object additionalProperties: true responses: '200': description: A2A JSON-RPC response components: schemas: AccessAgentBootstrapRequest: properties: agent_name: type: string maxLength: 120 minLength: 2 title: Agent Name agent_platform: anyOf: - type: string maxLength: 120 - type: 'null' title: Agent Platform requested_use_case: anyOf: - type: string maxLength: 1000 - type: 'null' title: Requested Use Case contact_email: anyOf: - type: string maxLength: 320 - type: 'null' title: Contact Email external_reference: anyOf: - type: string maxLength: 180 - type: 'null' title: External Reference requested_permissions: items: type: string type: array title: Requested Permissions ttl_hours: type: integer maximum: 168 minimum: 1 title: Ttl Hours default: 24 metadata: type: object title: Metadata type: object required: - agent_name title: AccessAgentBootstrapRequest AccessAgentBootstrapResponse: properties: setup_intent: $ref: '#/components/schemas/AccessSetupIntent' setup_intent_id: type: string title: Setup Intent Id owner_approval_url: anyOf: - type: string - type: 'null' title: Owner Approval Url setup_token: anyOf: - type: string - type: 'null' title: Setup Token setup_token_notice: anyOf: - type: string - type: 'null' title: Setup Token Notice sandbox_api_key: anyOf: - type: string - type: 'null' title: Sandbox Api Key sandbox_api_key_notice: anyOf: - type: string - type: 'null' title: Sandbox Api Key Notice sandbox_owner_id: anyOf: - type: string - type: 'null' title: Sandbox Owner Id allowed_sandbox_actions: anyOf: - items: type: string type: array - type: 'null' title: Allowed Sandbox Actions live_boundaries: anyOf: - items: type: string type: array - type: 'null' title: Live Boundaries agent_can_continue_sandbox: anyOf: - type: boolean - type: 'null' title: Agent Can Continue Sandbox owner_action_required: anyOf: - type: boolean - type: 'null' title: Owner Action Required manifest_evaluation: anyOf: - type: object - type: 'null' title: Manifest Evaluation pricing_recommendation: anyOf: - type: object - type: 'null' title: Pricing Recommendation live_api_key: anyOf: - type: string - type: 'null' title: Live Api Key live_api_key_notice: anyOf: - type: string - type: 'null' title: Live Api Key Notice live_key_prefix: anyOf: - type: string - type: 'null' title: Live Key Prefix activation_boundaries: anyOf: - items: type: string type: array - type: 'null' title: Activation Boundaries recommended_next_api_calls: anyOf: - items: type: string type: array - type: 'null' title: Recommended Next Api Calls additionalProperties: true type: object required: - setup_intent - setup_intent_id - owner_approval_url title: AccessAgentBootstrapResponse AccessAgentSetupApproveRequest: properties: setup_token: type: string maxLength: 300 minLength: 20 title: Setup Token approved_permissions: anyOf: - items: type: string type: array - type: 'null' title: Approved Permissions issue_live_key: type: boolean title: Issue Live Key default: true live_key_name: anyOf: - type: string maxLength: 100 - type: 'null' title: Live Key Name confirm_owner_approval: type: boolean title: Confirm Owner Approval default: false type: object required: - setup_token title: AccessAgentSetupApproveRequest AccessAgentSetupManifestRequest: properties: setup_token: type: string maxLength: 300 minLength: 20 title: Setup Token manifest: type: object title: Manifest type: object required: - setup_token - manifest title: AccessAgentSetupManifestRequest AccessAgentSetupStatusRequest: properties: setup_token: type: string maxLength: 300 minLength: 20 title: Setup Token type: object required: - setup_token title: AccessAgentSetupStatusRequest AccessApp: properties: id: type: string title: Id name: type: string title: Name external_app_id: anyOf: - type: string - type: 'null' title: External App Id status: type: string title: Status default_rail: type: string title: Default Rail live_mode: type: boolean title: Live Mode metadata: type: object title: Metadata created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - name - external_app_id - status - default_rail - live_mode - metadata - created_at - updated_at title: AccessApp AccessAppCreateRequest: properties: name: type: string maxLength: 120 minLength: 2 title: Name external_app_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External App Id default_rail: type: string title: Default Rail default: solana_usdc rail: anyOf: - type: string - type: 'null' title: Rail live_mode: type: boolean title: Live Mode default: false confirm_live_mode: type: boolean title: Confirm Live Mode default: false metadata: type: object title: Metadata type: object required: - name title: AccessAppCreateRequest AccessAppCreateResponse: properties: app: $ref: '#/components/schemas/AccessApp' rail: $ref: '#/components/schemas/AccessRailCapability' idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - app - rail title: AccessAppCreateResponse AccessBillingEntitlementResponse: properties: billing_entitlement: anyOf: - type: object - type: 'null' title: Billing Entitlement is_current: anyOf: - type: boolean - type: 'null' title: Is Current commercial_model: anyOf: - type: string - type: 'null' title: Commercial Model historical_billing_entitlement: anyOf: - type: object - type: 'null' title: Historical Billing Entitlement status: anyOf: - type: string - type: 'null' title: Status message: anyOf: - type: string - type: 'null' title: Message supported_sources: anyOf: - items: type: string type: array - type: 'null' title: Supported Sources supported_plans: anyOf: - items: type: string type: array - type: 'null' title: Supported Plans selection_policy: $ref: '#/components/schemas/AccessBillingSelectionPolicy' additionalProperties: true type: object required: - billing_entitlement - selection_policy title: AccessBillingEntitlementResponse AccessBillingSelectionPolicy: properties: current_statuses: items: type: string type: array title: Current Statuses current_rule: type: string title: Current Rule additionalProperties: true type: object required: - current_statuses - current_rule title: AccessBillingSelectionPolicy AccessBillingStripeCheckoutRequest: properties: plan: type: string title: Plan interval: type: string enum: - monthly - yearly title: Interval default: monthly success_url: type: string maxLength: 1000 minLength: 8 title: Success Url cancel_url: type: string maxLength: 1000 minLength: 8 title: Cancel Url canary_discount_code: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Canary Discount Code canary_target_minor_units: anyOf: - type: integer maximum: 100000 minimum: 50 - type: 'null' title: Canary Target Minor Units type: object required: - plan - success_url - cancel_url title: AccessBillingStripeCheckoutRequest AccessEffectiveRailEntry: properties: rail_id: type: string title: Rail Id available: type: boolean title: Available blockers: items: type: string type: array title: Blockers payout_address: anyOf: - type: string - type: 'null' title: Payout Address payout_address_source: anyOf: - type: string - type: 'null' title: Payout Address Source merchant_setting: anyOf: - $ref: '#/components/schemas/AccessRailSetting' - type: 'null' platform_setting: anyOf: - type: object - type: 'null' title: Platform Setting rail: $ref: '#/components/schemas/AccessRailCapability' payment_session: type: object title: Payment Session additionalProperties: true type: object required: - rail_id - available - blockers - payout_address - payout_address_source - merchant_setting - platform_setting - rail - payment_session title: AccessEffectiveRailEntry AccessEntitlement: properties: id: type: string title: Id access_app_id: anyOf: - type: string - type: 'null' title: Access App Id access_product_id: anyOf: - type: string - type: 'null' title: Access Product Id product_id: type: string title: Product Id external_customer_id: anyOf: - type: string - type: 'null' title: External Customer Id wallet: anyOf: - type: string - type: 'null' title: Wallet email: anyOf: - type: string - type: 'null' title: Email status: type: string title: Status active_from: anyOf: - type: string - type: 'null' title: Active From expires_at: anyOf: - type: string - type: 'null' title: Expires At receipt_id: anyOf: - type: string - type: 'null' title: Receipt Id payment_id: anyOf: - type: string - type: 'null' title: Payment Id last_payment_id: anyOf: - type: string - type: 'null' title: Last Payment Id rail_id: type: string title: Rail Id rail: $ref: '#/components/schemas/AccessRailCapability' livemode: type: boolean title: Livemode receipt: anyOf: - $ref: '#/components/schemas/AccessEntitlementReceipt' - type: 'null' usage: anyOf: - $ref: '#/components/schemas/AccessEntitlementUsage' - type: 'null' source: anyOf: - type: string - type: 'null' title: Source created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - access_app_id - access_product_id - product_id - external_customer_id - wallet - email - status - active_from - expires_at - receipt_id - payment_id - last_payment_id - rail_id - rail - livemode - receipt - usage - source - created_at - updated_at title: AccessEntitlement AccessEntitlementCheckRequest: properties: product_id: anyOf: - type: string format: uuid - type: 'null' title: Product Id external_product_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Product Id rail: anyOf: - type: string - type: 'null' title: Rail external_customer_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Customer Id wallet: anyOf: - type: string maxLength: 120 - type: 'null' title: Wallet email: anyOf: - type: string maxLength: 320 - type: 'null' title: Email customer_reference: anyOf: - type: string maxLength: 180 - type: 'null' title: Customer Reference type: object title: AccessEntitlementCheckRequest AccessEntitlementCheckResponse: properties: has_access: type: boolean title: Has Access status: type: string title: Status product_id: type: string title: Product Id access_product_id: type: string title: Access Product Id external_product_id: anyOf: - type: string - type: 'null' title: External Product Id rail_id: type: string title: Rail Id rail: $ref: '#/components/schemas/AccessRailCapability' livemode: type: boolean title: Livemode external_customer_id: anyOf: - type: string - type: 'null' title: External Customer Id wallet: anyOf: - type: string - type: 'null' title: Wallet email: anyOf: - type: string - type: 'null' title: Email active_from: anyOf: - type: string - type: 'null' title: Active From expires_at: anyOf: - type: string - type: 'null' title: Expires At receipt_id: anyOf: - type: string - type: 'null' title: Receipt Id receipt: anyOf: - $ref: '#/components/schemas/AccessEntitlementReceipt' - type: 'null' reason: type: string title: Reason last_payment_id: anyOf: - type: string - type: 'null' title: Last Payment Id source: type: string title: Source usage: anyOf: - $ref: '#/components/schemas/AccessEntitlementUsage' - type: 'null' additionalProperties: true type: object required: - has_access - status - product_id - access_product_id - external_product_id - rail_id - rail - livemode - external_customer_id - wallet - email - active_from - expires_at - receipt_id - receipt - reason - last_payment_id - source title: AccessEntitlementCheckResponse AccessEntitlementConsumeRequest: properties: product_id: anyOf: - type: string format: uuid - type: 'null' title: Product Id external_product_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Product Id external_customer_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Customer Id wallet: anyOf: - type: string maxLength: 120 - type: 'null' title: Wallet email: anyOf: - type: string maxLength: 320 - type: 'null' title: Email customer_reference: anyOf: - type: string maxLength: 180 - type: 'null' title: Customer Reference units: type: integer minimum: 1 title: Units default: 1 metadata: type: object title: Metadata type: object title: AccessEntitlementConsumeRequest AccessEntitlementConsumeResponse: properties: consumed: type: boolean title: Consumed units: type: integer title: Units usage_event: $ref: '#/components/schemas/AccessUsageEvent' entitlement: $ref: '#/components/schemas/AccessEntitlement' usage: anyOf: - $ref: '#/components/schemas/AccessEntitlementUsage' - type: 'null' idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - consumed - units - usage_event - entitlement - usage title: AccessEntitlementConsumeResponse AccessEntitlementReceipt: properties: id: type: string title: Id rail_id: type: string title: Rail Id additionalProperties: true type: object required: - id - rail_id title: AccessEntitlementReceipt AccessEntitlementReceiptReferenceResponse: properties: id: type: string title: Id rail_id: type: string title: Rail Id type: object required: - id - rail_id title: AccessEntitlementReceiptReferenceResponse AccessEntitlementResponse: properties: entitlement: $ref: '#/components/schemas/AccessEntitlement' additionalProperties: true type: object required: - entitlement title: AccessEntitlementResponse AccessEntitlementUsage: properties: unit: anyOf: - type: string - type: 'null' title: Unit granted: type: integer title: Granted consumed: type: integer title: Consumed remaining: type: integer title: Remaining exhausted: type: boolean title: Exhausted additionalProperties: true type: object required: - unit - granted - consumed - remaining - exhausted title: AccessEntitlementUsage AccessEntitlementUsageResponse: properties: unit: anyOf: - type: string - type: 'null' title: Unit granted: type: integer title: Granted consumed: type: integer title: Consumed remaining: type: integer title: Remaining exhausted: type: boolean title: Exhausted type: object required: - unit - granted - consumed - remaining - exhausted title: AccessEntitlementUsageResponse AccessFeeCollection: properties: mode: type: string title: Mode status: type: string title: Status fee_collector_address: anyOf: - type: string - type: 'null' title: Fee Collector Address allowance_token_contract: anyOf: - type: string - type: 'null' title: Allowance Token Contract allowance_limit_minor_units: anyOf: - type: integer - type: 'null' title: Allowance Limit Minor Units allowance_spent_minor_units: type: integer title: Allowance Spent Minor Units allowance_expires_at: anyOf: - type: string - type: 'null' title: Allowance Expires At allowance_tx_hash: anyOf: - type: string - type: 'null' title: Allowance Tx Hash metadata: type: object title: Metadata additionalProperties: true type: object required: - mode - status - fee_collector_address - allowance_token_contract - allowance_limit_minor_units - allowance_spent_minor_units - allowance_expires_at - allowance_tx_hash - metadata title: AccessFeeCollection AccessMeteredAsset: properties: symbol: type: string enum: - USDC const: USDC title: Symbol mint: type: string title: Mint decimals: type: integer enum: - 6 const: 6 title: Decimals additionalProperties: true type: object required: - symbol - mint - decimals title: AccessMeteredAsset AccessMeteredChannel: properties: id: anyOf: - type: string - type: 'null' title: Id payer_wallet: anyOf: - type: string - type: 'null' title: Payer Wallet authorized_signer: anyOf: - type: string - type: 'null' title: Authorized Signer highest_voucher_signature: anyOf: - type: string - type: 'null' title: Highest Voucher Signature close_requested_at: anyOf: - type: string - type: 'null' title: Close Requested At settlement_signature: anyOf: - type: string - type: 'null' title: Settlement Signature additionalProperties: true type: object required: - id - payer_wallet - authorized_signer - highest_voucher_signature - close_requested_at - settlement_signature title: AccessMeteredChannel AccessMeteredCommit: properties: deliveryId: type: string title: Deliveryid sessionId: anyOf: - type: string - type: 'null' title: Sessionid amount: type: string title: Amount cumulative: type: string title: Cumulative status: type: string title: Status additionalProperties: true type: object required: - deliveryId - amount - cumulative - status title: AccessMeteredCommit AccessMeteredCommitRequest: properties: deliveryId: type: string maxLength: 180 minLength: 1 title: Deliveryid voucher: $ref: '#/components/schemas/AccessMeteredSignedVoucher' type: object required: - deliveryId - voucher title: AccessMeteredCommitRequest AccessMeteredCommitResponse: properties: commit: $ref: '#/components/schemas/AccessMeteredCommit' metered_session: $ref: '#/components/schemas/AccessMeteredSession' additionalProperties: true type: object required: - commit - metered_session title: AccessMeteredCommitResponse AccessMeteredDelivery: properties: deliveryId: type: string title: Deliveryid sessionId: type: string title: Sessionid amount: type: string title: Amount currency: type: string enum: - USDC const: USDC title: Currency sequence: type: integer title: Sequence expiresAt: type: integer title: Expiresat commitUrl: type: string title: Commiturl status: anyOf: - type: string - type: 'null' title: Status cumulative: anyOf: - type: string - type: 'null' title: Cumulative additionalProperties: true type: object required: - deliveryId - sessionId - amount - currency - sequence - expiresAt - commitUrl title: AccessMeteredDelivery AccessMeteredDeliveryCreateRequest: properties: units: type: integer maximum: 1000000 minimum: 1 title: Units default: 1 delivery_id: anyOf: - type: string maxLength: 180 minLength: 1 - type: 'null' title: Delivery Id proof: anyOf: - type: string maxLength: 2000 - type: 'null' title: Proof ttl_seconds: type: integer maximum: 900 minimum: 30 title: Ttl Seconds default: 300 type: object title: AccessMeteredDeliveryCreateRequest AccessMeteredDeliveryEvidence: properties: delivery_id: type: string title: Delivery Id sequence: type: integer title: Sequence amount_minor_units: type: integer title: Amount Minor Units cumulative_minor_units: anyOf: - type: integer - type: 'null' title: Cumulative Minor Units status: type: string title: Status voucher_signature: anyOf: - type: string - type: 'null' title: Voucher Signature expires_at: type: string title: Expires At committed_at: anyOf: - type: string - type: 'null' title: Committed At created_at: type: string title: Created At additionalProperties: true type: object required: - delivery_id - sequence - amount_minor_units - cumulative_minor_units - status - voucher_signature - expires_at - committed_at - created_at title: AccessMeteredDeliveryEvidence AccessMeteredDeliveryResponse: properties: delivery: $ref: '#/components/schemas/AccessMeteredDelivery' units: type: integer title: Units unit_price_minor_units: type: integer title: Unit Price Minor Units commit_url: type: string title: Commit Url idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - delivery - units - unit_price_minor_units - commit_url title: AccessMeteredDeliveryResponse AccessMeteredEndpoints: properties: authorize: type: string title: Authorize deliveries: type: string title: Deliveries commits: type: string title: Commits settle: type: string title: Settle additionalProperties: true type: object required: - authorize - deliveries - commits - settle title: AccessMeteredEndpoints AccessMeteredFee: properties: bps: type: integer title: Bps paid_from_settled_amount: type: boolean enum: - true const: true title: Paid From Settled Amount minor_units: type: integer title: Minor Units additionalProperties: true type: object required: - bps - paid_from_settled_amount - minor_units title: AccessMeteredFee AccessMeteredProduct: properties: id: type: string title: Id external_id: anyOf: - type: string - type: 'null' title: External Id title: anyOf: - type: string - type: 'null' title: Title additionalProperties: true type: object required: - id - external_id - title title: AccessMeteredProduct AccessMeteredSession: properties: id: type: string title: Id status: type: string title: Status protocol: type: string enum: - mpp const: mpp title: Protocol intent: type: string enum: - session const: session title: Intent rail_id: type: string enum: - solana_usdc const: solana_usdc title: Rail Id network: type: string title: Network payment_channel_program: type: string title: Payment Channel Program asset: $ref: '#/components/schemas/AccessMeteredAsset' external_customer_id: type: string title: External Customer Id product: $ref: '#/components/schemas/AccessMeteredProduct' metering: $ref: '#/components/schemas/AccessMeteringState' fee: $ref: '#/components/schemas/AccessMeteredFee' settlement: $ref: '#/components/schemas/AccessMeteredSettlement' channel: $ref: '#/components/schemas/AccessMeteredChannel' endpoints: $ref: '#/components/schemas/AccessMeteredEndpoints' expires_at: type: string title: Expires At opened_at: anyOf: - type: string - type: 'null' title: Opened At settled_at: anyOf: - type: string - type: 'null' title: Settled At created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At deliveries: items: $ref: '#/components/schemas/AccessMeteredDeliveryEvidence' type: array title: Deliveries additionalProperties: true type: object required: - id - status - protocol - intent - rail_id - network - payment_channel_program - asset - external_customer_id - product - metering - fee - settlement - channel - endpoints - expires_at - opened_at - settled_at - created_at - updated_at - deliveries title: AccessMeteredSession AccessMeteredSessionCreateRequest: properties: product_id: anyOf: - type: string format: uuid - type: 'null' title: Product Id external_product_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Product Id external_customer_id: type: string maxLength: 180 minLength: 1 title: External Customer Id cap_minor_units: type: integer minimum: 1 title: Cap Minor Units expires_in_seconds: type: integer maximum: 86400 minimum: 300 title: Expires In Seconds default: 3600 metadata: type: object title: Metadata type: object required: - external_customer_id - cap_minor_units title: AccessMeteredSessionCreateRequest AccessMeteredSessionCreateResponse: properties: metered_session: $ref: '#/components/schemas/AccessMeteredSession' challenge: type: string title: Challenge idempotent_replay: type: boolean title: Idempotent Replay additionalProperties: true type: object required: - metered_session - challenge - idempotent_replay title: AccessMeteredSessionCreateResponse AccessMeteredSessionResponse: properties: metered_session: $ref: '#/components/schemas/AccessMeteredSession' payment_receipt: anyOf: - type: string - type: 'null' title: Payment Receipt idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - metered_session title: AccessMeteredSessionResponse AccessMeteredSettlement: properties: merchant_minor_units: type: integer title: Merchant Minor Units hilt_fee_minor_units: type: integer title: Hilt Fee Minor Units rounding_residual_minor_units: type: integer title: Rounding Residual Minor Units additionalProperties: true type: object required: - merchant_minor_units - hilt_fee_minor_units - rounding_residual_minor_units title: AccessMeteredSettlement AccessMeteredSignedVoucher: properties: voucher: $ref: '#/components/schemas/AccessMeteredVoucher' signer: type: string maxLength: 64 minLength: 32 title: Signer signature: type: string maxLength: 128 minLength: 64 title: Signature signatureType: type: string enum: - ed25519 const: ed25519 title: Signaturetype type: object required: - voucher - signer - signature - signatureType title: AccessMeteredSignedVoucher AccessMeteredVoucher: properties: channelId: type: string maxLength: 64 minLength: 32 title: Channelid cumulativeAmount: type: string maxLength: 20 minLength: 1 pattern: ^\d+$ title: Cumulativeamount expiresAt: type: integer minimum: 1 title: Expiresat type: object required: - channelId - cumulativeAmount - expiresAt title: AccessMeteredVoucher AccessMetering: properties: usage_unit: type: string title: Usage Unit units_per_payment: type: integer title: Units Per Payment additionalProperties: true type: object required: - usage_unit - units_per_payment title: AccessMetering AccessMeteringState: properties: usage_unit: type: string title: Usage Unit unit_price_minor_units: type: integer title: Unit Price Minor Units cap_minor_units: type: integer title: Cap Minor Units deposit_minor_units: type: integer title: Deposit Minor Units committed_minor_units: type: integer title: Committed Minor Units remaining_minor_units: type: integer title: Remaining Minor Units additionalProperties: true type: object required: - usage_unit - unit_price_minor_units - cap_minor_units - deposit_minor_units - committed_minor_units - remaining_minor_units title: AccessMeteringState AccessPaymentProof: properties: id: type: string title: Id owner_id: type: string title: Owner Id access_product_id: anyOf: - type: string - type: 'null' title: Access Product Id product_id: anyOf: - type: string - type: 'null' title: Product Id payment_id: anyOf: - type: string - type: 'null' title: Payment Id rail_id: type: string title: Rail Id proof_type: anyOf: - type: string - type: 'null' title: Proof Type proof_fingerprint: anyOf: - type: string - type: 'null' title: Proof Fingerprint proof_reference: anyOf: - type: string - type: 'null' title: Proof Reference external_customer_id: anyOf: - type: string - type: 'null' title: External Customer Id wallet: anyOf: - type: string - type: 'null' title: Wallet email: anyOf: - type: string - type: 'null' title: Email amount_minor_units: anyOf: - type: integer - type: 'null' title: Amount Minor Units settlement_asset: anyOf: - type: string - type: 'null' title: Settlement Asset network: anyOf: - type: string - type: 'null' title: Network livemode: type: boolean title: Livemode status: anyOf: - type: string - type: 'null' title: Status evidence: type: object title: Evidence idempotency_key: anyOf: - type: string - type: 'null' title: Idempotency Key created_by_key_id: anyOf: - type: string - type: 'null' title: Created By Key Id created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - owner_id - access_product_id - product_id - payment_id - rail_id - proof_type - proof_fingerprint - proof_reference - external_customer_id - wallet - email - amount_minor_units - settlement_asset - network - livemode - status - evidence - idempotency_key - created_by_key_id - created_at - updated_at title: AccessPaymentProof AccessPaymentProofResponse: properties: payment_proof: $ref: '#/components/schemas/AccessPaymentProof' rail: $ref: '#/components/schemas/AccessRailCapability' proof_submission: $ref: '#/components/schemas/AccessPaymentProofSubmission' idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - payment_proof - rail - proof_submission title: AccessPaymentProofResponse AccessPaymentProofSubmission: properties: status: type: string title: Status payment_session_id: anyOf: - type: string - type: 'null' title: Payment Session Id payment_requirement_bound: type: boolean title: Payment Requirement Bound payment_requirement_record: anyOf: - type: object - type: 'null' title: Payment Requirement Record verification_status: type: string title: Verification Status settlement_status: type: string title: Settlement Status receipt_mapping_status: type: string title: Receipt Mapping Status entitlement_activation_status: type: string title: Entitlement Activation Status next_step: type: string title: Next Step additionalProperties: true type: object required: - status - payment_session_id - payment_requirement_bound - payment_requirement_record - verification_status - settlement_status - receipt_mapping_status - entitlement_activation_status - next_step title: AccessPaymentProofSubmission AccessPaymentProofSubmitRequest: properties: product_id: anyOf: - type: string format: uuid - type: 'null' title: Product Id external_product_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Product Id payment_session_id: anyOf: - type: string maxLength: 180 - type: 'null' title: Payment Session Id rail: type: string title: Rail default: solana_usdc proof_type: anyOf: - type: string maxLength: 120 - type: 'null' title: Proof Type proof_payload: type: object title: Proof Payload external_customer_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Customer Id wallet: anyOf: - type: string maxLength: 180 - type: 'null' title: Wallet email: anyOf: - type: string maxLength: 320 - type: 'null' title: Email amount_minor_units: anyOf: - type: integer minimum: 1 - type: 'null' title: Amount Minor Units livemode: type: boolean title: Livemode default: true metadata: type: object title: Metadata type: object required: - proof_payload title: AccessPaymentProofSubmitRequest AccessPaymentSession: properties: id: type: string title: Id payment_id: anyOf: - type: string - type: 'null' title: Payment Id session_id: anyOf: - type: string - type: 'null' title: Session Id status: type: string title: Status rail: type: string title: Rail rail_id: type: string title: Rail Id checkout_url: anyOf: - type: string - type: 'null' title: Checkout Url expires_at: anyOf: - type: string - type: 'null' title: Expires At amount_minor_units: anyOf: - type: integer - type: 'null' title: Amount Minor Units asset_symbol: anyOf: - type: string - type: 'null' title: Asset Symbol asset_decimals: anyOf: - type: integer - type: 'null' title: Asset Decimals merchant_wallet: anyOf: - type: string - type: 'null' title: Merchant Wallet payment_protocol: anyOf: - type: string - type: 'null' title: Payment Protocol settlement_rail_id: anyOf: - type: string - type: 'null' title: Settlement Rail Id settlement_network: anyOf: - type: string - type: 'null' title: Settlement Network settlement_asset: anyOf: - type: string - type: 'null' title: Settlement Asset payment_requirement: anyOf: - type: object - type: 'null' title: Payment Requirement phantom_mobile: anyOf: - type: object - type: 'null' title: Phantom Mobile adapter: type: object title: Adapter additionalProperties: true type: object required: - id - payment_id - session_id - status - rail - rail_id - checkout_url - expires_at - amount_minor_units - asset_symbol - asset_decimals - merchant_wallet - payment_protocol - settlement_rail_id - settlement_network - settlement_asset - payment_requirement - phantom_mobile - adapter title: AccessPaymentSession AccessPaymentSessionCreateRequest: properties: product_id: anyOf: - type: string format: uuid - type: 'null' title: Product Id external_product_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Product Id external_customer_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Customer Id wallet: anyOf: - type: string maxLength: 120 - type: 'null' title: Wallet email: anyOf: - type: string maxLength: 320 - type: 'null' title: Email amount_minor_units: anyOf: - type: integer minimum: 1 - type: 'null' title: Amount Minor Units rail: anyOf: - type: string - type: 'null' title: Rail description: Hosted settlement rail for this session. Public live values are solana_usdc and solana_sol. examples: - solana_usdc - solana_sol payment_protocol: anyOf: - type: string maxLength: 80 - type: 'null' title: Payment Protocol settlement_rail: anyOf: - type: string maxLength: 80 - type: 'null' title: Settlement Rail settlement_rail_id: anyOf: - type: string maxLength: 80 - type: 'null' title: Settlement Rail Id metadata: type: object title: Metadata type: object title: AccessPaymentSessionCreateRequest AccessPaymentSessionResponse: properties: payment_session: $ref: '#/components/schemas/AccessPaymentSession' pending_entitlement: $ref: '#/components/schemas/AccessEntitlement' rail: $ref: '#/components/schemas/AccessRailCapability' selected_rail: $ref: '#/components/schemas/AccessEffectiveRailEntry' available_rails: items: $ref: '#/components/schemas/AccessEffectiveRailEntry' type: array title: Available Rails payment_session_options: type: object title: Payment Session Options idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - payment_session - pending_entitlement - rail - selected_rail - available_rails - payment_session_options title: AccessPaymentSessionResponse AccessProduct: properties: id: type: string title: Id access_app_id: anyOf: - type: string - type: 'null' title: Access App Id product_id: type: string title: Product Id external_product_id: anyOf: - type: string - type: 'null' title: External Product Id status: type: string title: Status default_rail: type: string title: Default Rail rail_id: type: string title: Rail Id allowed_rails: items: type: string type: array title: Allowed Rails billing_model: type: string title: Billing Model renewal_mode: type: string title: Renewal Mode billing_interval_days: anyOf: - type: integer - type: 'null' title: Billing Interval Days cancel_at_period_end: anyOf: - type: boolean - type: 'null' title: Cancel At Period End grace_period_days: anyOf: - type: integer - type: 'null' title: Grace Period Days entitlement_duration_seconds: anyOf: - type: integer - type: 'null' title: Entitlement Duration Seconds metering: anyOf: - $ref: '#/components/schemas/AccessMetering' - type: 'null' live_mode_confirmed: type: boolean title: Live Mode Confirmed metadata: type: object title: Metadata created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - access_app_id - product_id - external_product_id - status - default_rail - rail_id - allowed_rails - billing_model - renewal_mode - billing_interval_days - cancel_at_period_end - grace_period_days - entitlement_duration_seconds - metering - live_mode_confirmed - metadata - created_at - updated_at title: AccessProduct AccessProductCreateRequest: properties: access_app_id: anyOf: - type: string format: uuid - type: 'null' title: Access App Id external_product_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Product Id existing_product_id: anyOf: - type: string format: uuid - type: 'null' title: Existing Product Id title: anyOf: - type: string maxLength: 180 - type: 'null' title: Title description: anyOf: - type: string maxLength: 1000 - type: 'null' title: Description image_url: anyOf: - type: string maxLength: 500 - type: 'null' title: Image Url amount_minor_units: anyOf: - type: integer minimum: 1 - type: 'null' title: Amount Minor Units merchant_wallet: anyOf: - type: string maxLength: 120 - type: 'null' title: Merchant Wallet billing_model: type: string title: Billing Model default: one_off renewal_mode: anyOf: - type: string maxLength: 80 - type: 'null' title: Renewal Mode billing_interval_days: anyOf: - type: integer minimum: 1 - type: 'null' title: Billing Interval Days entitlement_duration_days: anyOf: - type: integer minimum: 1 - type: 'null' title: Entitlement Duration Days default: 30 usage_unit: anyOf: - type: string maxLength: 80 minLength: 1 - type: 'null' title: Usage Unit usage_units_per_payment: anyOf: - type: integer minimum: 1 - type: 'null' title: Usage Units Per Payment cancel_at_period_end: type: boolean title: Cancel At Period End default: true grace_period_days: type: integer minimum: 0 title: Grace Period Days default: 0 default_rail: type: string title: Default Rail description: Default hosted settlement rail. Public live values are solana_usdc and solana_sol. default: solana_usdc examples: - solana_usdc - solana_sol allowed_rails: items: type: string type: array title: Allowed Rails description: Hosted settlement rails allowed for this product. Use one asset per product. examples: - - solana_usdc - - solana_sol rail: anyOf: - type: string - type: 'null' title: Rail description: Optional alias for the product's default hosted settlement rail. examples: - solana_usdc - solana_sol status: type: string title: Status default: paused live_mode_confirmed: type: boolean title: Live Mode Confirmed default: false metadata: type: object title: Metadata type: object title: AccessProductCreateRequest AccessProductCreateResponse: properties: access_product: $ref: '#/components/schemas/AccessProduct' hilt_product: $ref: '#/components/schemas/HiltProductReference' rail: $ref: '#/components/schemas/AccessRailCapability' idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - access_product - hilt_product - rail title: AccessProductCreateResponse AccessProductRailsResponse: properties: product: $ref: '#/components/schemas/AccessProduct' mode: type: string title: Mode default_rail: type: string title: Default Rail allowed_rails: items: type: string type: array title: Allowed Rails available_rails: items: $ref: '#/components/schemas/AccessEffectiveRailEntry' type: array title: Available Rails blocked_rails: items: $ref: '#/components/schemas/AccessEffectiveRailEntry' type: array title: Blocked Rails payment_session_options: type: object title: Payment Session Options additionalProperties: true type: object required: - product - mode - default_rail - allowed_rails - available_rails - blocked_rails - payment_session_options title: AccessProductRailsResponse AccessRailCapability: properties: id: type: string title: Id rail_id: type: string title: Rail Id display_name: type: string title: Display Name status: type: string title: Status network: type: string title: Network settlement_asset: type: string title: Settlement Asset live_capable: type: boolean title: Live Capable default_enabled: type: boolean title: Default Enabled supports_sandbox: type: boolean title: Supports Sandbox supports_live: type: boolean title: Supports Live supports_hosted_session: type: boolean title: Supports Hosted Session supports_direct_http_402: type: boolean title: Supports Direct Http 402 docs_url: anyOf: - type: string - type: 'null' title: Docs Url capability_kind: type: string title: Capability Kind payment_protocol: anyOf: - type: string - type: 'null' title: Payment Protocol settlement_rail_id: anyOf: - type: string - type: 'null' title: Settlement Rail Id supports_mpp_session: type: boolean title: Supports Mpp Session default: false payment_channel_program: anyOf: - type: string - type: 'null' title: Payment Channel Program additionalProperties: true type: object required: - id - rail_id - display_name - status - network - settlement_asset - live_capable - default_enabled - supports_sandbox - supports_live - supports_hosted_session - supports_direct_http_402 - docs_url - capability_kind - payment_protocol - settlement_rail_id title: AccessRailCapability AccessRailSetting: properties: id: anyOf: - type: string - type: 'null' title: Id rail_id: type: string title: Rail Id rail: $ref: '#/components/schemas/AccessRailCapability' enabled: type: boolean title: Enabled mode: type: string title: Mode status: type: string title: Status payout_address: anyOf: - type: string - type: 'null' title: Payout Address label: anyOf: - type: string - type: 'null' title: Label verification_status: type: string title: Verification Status metadata: type: object title: Metadata fee_collection: $ref: '#/components/schemas/AccessFeeCollection' pending_review_age_seconds: anyOf: - type: integer - type: 'null' title: Pending Review Age Seconds created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - rail_id - rail - enabled - mode - status - payout_address - label - verification_status - metadata - fee_collection - pending_review_age_seconds - created_at - updated_at title: AccessRailSetting AccessRailSettingListItem: properties: rail_id: type: string title: Rail Id rail: $ref: '#/components/schemas/AccessRailCapability' setting: anyOf: - $ref: '#/components/schemas/AccessRailSetting' - type: 'null' platform_setting: anyOf: - type: object - type: 'null' title: Platform Setting configured: type: boolean title: Configured additionalProperties: true type: object required: - rail_id - rail - setting - platform_setting - configured title: AccessRailSettingListItem AccessRailSettingResponse: properties: rail_setting: $ref: '#/components/schemas/AccessRailSetting' idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - rail_setting title: AccessRailSettingResponse AccessRailSettingUpdateRequest: properties: enabled: type: boolean title: Enabled default: false payout_address: anyOf: - type: string maxLength: 180 - type: 'null' title: Payout Address label: anyOf: - type: string maxLength: 120 - type: 'null' title: Label mode: type: string title: Mode default: live fee_collection_mode: anyOf: - type: string maxLength: 80 - type: 'null' title: Fee Collection Mode fee_collection_status: anyOf: - type: string maxLength: 80 - type: 'null' title: Fee Collection Status fee_collector_address: anyOf: - type: string maxLength: 180 - type: 'null' title: Fee Collector Address fee_allowance_token_contract: anyOf: - type: string maxLength: 180 - type: 'null' title: Fee Allowance Token Contract fee_allowance_limit_minor_units: anyOf: - type: integer minimum: 0 - type: 'null' title: Fee Allowance Limit Minor Units fee_allowance_spent_minor_units: anyOf: - type: integer minimum: 0 - type: 'null' title: Fee Allowance Spent Minor Units fee_allowance_expires_at: anyOf: - type: string maxLength: 80 - type: 'null' title: Fee Allowance Expires At fee_allowance_tx_hash: anyOf: - type: string maxLength: 180 - type: 'null' title: Fee Allowance Tx Hash fee_collection_metadata: type: object title: Fee Collection Metadata metadata: type: object title: Metadata type: object title: AccessRailSettingUpdateRequest AccessRailSettingsResponse: properties: rail_settings: items: $ref: '#/components/schemas/AccessRailSettingListItem' type: array title: Rail Settings generated_at: type: string title: Generated At additionalProperties: true type: object required: - rail_settings - generated_at title: AccessRailSettingsResponse AccessRailsCaller: properties: user_id: type: string title: User Id sandbox: type: boolean title: Sandbox additionalProperties: true type: object required: - user_id - sandbox title: AccessRailsCaller AccessRailsResponse: properties: default_rail: type: string title: Default Rail rails: items: $ref: '#/components/schemas/AccessRailCapability' type: array title: Rails caller: $ref: '#/components/schemas/AccessRailsCaller' additionalProperties: true type: object required: - default_rail - rails - caller title: AccessRailsResponse AccessSandboxPaymentSessionConfirmRequest: properties: proof: type: string maxLength: 500 minLength: 12 title: Proof type: object required: - proof title: AccessSandboxPaymentSessionConfirmRequest AccessSandboxPaymentSessionCreateRequest: properties: product_id: anyOf: - type: string format: uuid - type: 'null' title: Product Id external_product_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Product Id external_customer_id: anyOf: - type: string maxLength: 180 - type: 'null' title: External Customer Id wallet: anyOf: - type: string maxLength: 120 - type: 'null' title: Wallet email: anyOf: - type: string maxLength: 320 - type: 'null' title: Email rail: anyOf: - type: string - type: 'null' title: Rail ttl_minutes: type: integer maximum: 120 minimum: 5 title: Ttl Minutes default: 30 confirm_sandbox_mode: type: boolean title: Confirm Sandbox Mode default: false metadata: type: object title: Metadata type: object title: AccessSandboxPaymentSessionCreateRequest AccessSandboxSession: properties: id: type: string title: Id status: type: string title: Status livemode: type: boolean enum: - false const: false title: Livemode sandbox_only: type: boolean enum: - true const: true title: Sandbox Only access_app_id: anyOf: - type: string - type: 'null' title: Access App Id access_product_id: type: string title: Access Product Id product_id: type: string title: Product Id entitlement_id: anyOf: - type: string - type: 'null' title: Entitlement Id external_customer_id: anyOf: - type: string - type: 'null' title: External Customer Id wallet: anyOf: - type: string - type: 'null' title: Wallet email: anyOf: - type: string - type: 'null' title: Email rail_id: type: string title: Rail Id rail: $ref: '#/components/schemas/AccessRailCapability' proof_type: type: string title: Proof Type proof_reference_preview: anyOf: - type: string - type: 'null' title: Proof Reference Preview proof: anyOf: - type: string - type: 'null' title: Proof expires_at: anyOf: - type: string - type: 'null' title: Expires At confirmed_at: anyOf: - type: string - type: 'null' title: Confirmed At failed_reason: anyOf: - type: string - type: 'null' title: Failed Reason created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - status - livemode - sandbox_only - access_app_id - access_product_id - product_id - entitlement_id - external_customer_id - wallet - email - rail_id - rail - proof_type - proof_reference_preview - expires_at - confirmed_at - failed_reason - created_at - updated_at title: AccessSandboxSession AccessSandboxSessionConfirmResponse: properties: sandbox_session: $ref: '#/components/schemas/AccessSandboxSession' entitlement: $ref: '#/components/schemas/AccessEntitlement' livemode: anyOf: - type: boolean enum: - false const: false - type: 'null' title: Livemode sandbox_only: anyOf: - type: boolean enum: - true const: true - type: 'null' title: Sandbox Only message: anyOf: - type: string - type: 'null' title: Message idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - sandbox_session - entitlement title: AccessSandboxSessionConfirmResponse AccessSandboxSessionCreateResponse: properties: sandbox_session: $ref: '#/components/schemas/AccessSandboxSession' pending_entitlement: $ref: '#/components/schemas/AccessEntitlement' rail: $ref: '#/components/schemas/AccessRailCapability' payment_session_adapter: anyOf: - type: object - type: 'null' title: Payment Session Adapter livemode: type: boolean enum: - false const: false title: Livemode sandbox_only: type: boolean enum: - true const: true title: Sandbox Only message: type: string title: Message idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - sandbox_session - pending_entitlement - rail - payment_session_adapter - livemode - sandbox_only - message title: AccessSandboxSessionCreateResponse AccessSetupIntent: properties: id: type: string title: Id status: type: string title: Status agent_name: type: string title: Agent Name agent_platform: anyOf: - type: string - type: 'null' title: Agent Platform requested_use_case: anyOf: - type: string - type: 'null' title: Requested Use Case contact_email: anyOf: - type: string - type: 'null' title: Contact Email external_reference: anyOf: - type: string - type: 'null' title: External Reference requested_permissions: items: type: string type: array title: Requested Permissions approved_permissions: items: type: string type: array title: Approved Permissions sandbox_owner_id: anyOf: - type: string - type: 'null' title: Sandbox Owner Id approved_owner_id: anyOf: - type: string - type: 'null' title: Approved Owner Id sandbox_key_id: anyOf: - type: string - type: 'null' title: Sandbox Key Id live_key_id: anyOf: - type: string - type: 'null' title: Live Key Id setup_url: anyOf: - type: string - type: 'null' title: Setup Url expires_at: anyOf: - type: string - type: 'null' title: Expires At approved_at: anyOf: - type: string - type: 'null' title: Approved At live_key_issued_at: anyOf: - type: string - type: 'null' title: Live Key Issued At revoked_at: anyOf: - type: string - type: 'null' title: Revoked At metadata: type: object title: Metadata created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - status - agent_name - agent_platform - requested_use_case - contact_email - external_reference - requested_permissions - approved_permissions - sandbox_owner_id - approved_owner_id - sandbox_key_id - live_key_id - setup_url - expires_at - approved_at - live_key_issued_at - revoked_at - metadata - created_at - updated_at title: AccessSetupIntent AccessSetupReadinessResponse: properties: ready: type: boolean title: Ready mode: type: string title: Mode app: type: object title: App product: type: object title: Product rails: type: object title: Rails webhooks: type: object title: Webhooks blockers: items: type: object type: array title: Blockers next_actions: items: type: object type: array title: Next Actions agent_setup: type: object title: Agent Setup generated_at: type: string title: Generated At additionalProperties: true type: object required: - ready - mode - app - product - rails - webhooks - blockers - next_actions - agent_setup - generated_at title: AccessSetupReadinessResponse AccessUsageEvent: properties: id: type: string title: Id units: type: integer title: Units usage_unit: type: string title: Usage Unit created_at: anyOf: - type: string - type: 'null' title: Created At additionalProperties: true type: object required: - id - units - usage_unit - created_at title: AccessUsageEvent AccessWebhookCreateRequest: properties: label: type: string maxLength: 120 minLength: 2 title: Label url: type: string title: Url subscribed_events: items: type: string type: array title: Subscribed Events product_ids: items: type: string format: uuid type: array title: Product Ids metadata: type: object title: Metadata type: object required: - label - url title: AccessWebhookCreateRequest AccessWebhookCreateResponse: properties: endpoint: $ref: '#/components/schemas/WebhookEndpoint' signing_secret: type: string title: Signing Secret supported_events: items: type: string type: array title: Supported Events idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - endpoint - signing_secret - supported_events title: AccessWebhookCreateResponse AccessX402EntitlementResponse: properties: id: type: string title: Id access_app_id: anyOf: - type: string - type: 'null' title: Access App Id access_product_id: anyOf: - type: string - type: 'null' title: Access Product Id product_id: type: string title: Product Id external_customer_id: anyOf: - type: string - type: 'null' title: External Customer Id wallet: anyOf: - type: string - type: 'null' title: Wallet email: anyOf: - type: string - type: 'null' title: Email status: type: string title: Status active_from: anyOf: - type: string - type: 'null' title: Active From expires_at: anyOf: - type: string - type: 'null' title: Expires At receipt_id: anyOf: - type: string - type: 'null' title: Receipt Id payment_id: anyOf: - type: string - type: 'null' title: Payment Id last_payment_id: anyOf: - type: string - type: 'null' title: Last Payment Id rail_id: type: string title: Rail Id rail: type: object title: Rail livemode: type: boolean title: Livemode receipt: anyOf: - $ref: '#/components/schemas/AccessEntitlementReceiptReferenceResponse' - type: 'null' usage: anyOf: - $ref: '#/components/schemas/AccessEntitlementUsageResponse' - type: 'null' source: anyOf: - type: string - type: 'null' title: Source created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At type: object required: - id - access_app_id - access_product_id - product_id - external_customer_id - wallet - email - status - active_from - expires_at - receipt_id - payment_id - last_payment_id - rail_id - rail - livemode - receipt - usage - source - created_at - updated_at title: AccessX402EntitlementResponse AccessX402PaymentProofResponse: properties: id: type: string title: Id owner_id: type: string title: Owner Id access_product_id: anyOf: - type: string - type: 'null' title: Access Product Id product_id: anyOf: - type: string - type: 'null' title: Product Id payment_id: anyOf: - type: string - type: 'null' title: Payment Id rail_id: type: string title: Rail Id proof_type: anyOf: - type: string - type: 'null' title: Proof Type proof_fingerprint: anyOf: - type: string - type: 'null' title: Proof Fingerprint proof_reference: anyOf: - type: string - type: 'null' title: Proof Reference external_customer_id: anyOf: - type: string - type: 'null' title: External Customer Id wallet: anyOf: - type: string - type: 'null' title: Wallet email: anyOf: - type: string - type: 'null' title: Email amount_minor_units: anyOf: - type: integer - type: 'null' title: Amount Minor Units settlement_asset: anyOf: - type: string - type: 'null' title: Settlement Asset network: anyOf: - type: string - type: 'null' title: Network livemode: type: boolean title: Livemode status: anyOf: - type: string - type: 'null' title: Status evidence: type: object title: Evidence idempotency_key: anyOf: - type: string - type: 'null' title: Idempotency Key created_by_key_id: anyOf: - type: string - type: 'null' title: Created By Key Id created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At type: object required: - id - owner_id - access_product_id - product_id - payment_id - rail_id - proof_type - proof_fingerprint - proof_reference - external_customer_id - wallet - email - amount_minor_units - settlement_asset - network - livemode - status - evidence - idempotency_key - created_by_key_id - created_at - updated_at title: AccessX402PaymentProofResponse AccessX402PaymentResponse: properties: success: type: boolean enum: - true const: true title: Success transaction: type: string title: Transaction network: type: string title: Network type: object required: - success - transaction - network title: AccessX402PaymentResponse AccessX402ReceiptResponse: properties: id: type: string title: Id tx_sig: type: string title: Tx Sig created: type: boolean title: Created type: object required: - id - tx_sig - created title: AccessX402ReceiptResponse AccessX402ResponseHeaders: properties: PAYMENT-RESPONSE: type: string title: Payment-Response type: object required: - PAYMENT-RESPONSE title: AccessX402ResponseHeaders AccessX402SettleRequest: properties: payment_session_id: type: string maxLength: 180 minLength: 8 title: Payment Session Id payment_signature: anyOf: - type: string maxLength: 131072 minLength: 8 - type: 'null' title: Payment Signature type: object required: - payment_session_id title: AccessX402SettleRequest AccessX402SettleResponse: properties: x402Version: type: integer enum: - 2 const: 2 title: X402Version payment_session_id: type: string title: Payment Session Id payment_proof: $ref: '#/components/schemas/AccessX402PaymentProofResponse' settlement_evidence: $ref: '#/components/schemas/AccessX402SettlementEvidenceResponse' receipt: $ref: '#/components/schemas/AccessX402ReceiptResponse' entitlement: $ref: '#/components/schemas/AccessX402EntitlementResponse' payment_response: $ref: '#/components/schemas/AccessX402PaymentResponse' headers: $ref: '#/components/schemas/AccessX402ResponseHeaders' idempotent_replay: type: boolean title: Idempotent Replay default: false type: object required: - x402Version - payment_session_id - payment_proof - settlement_evidence - receipt - entitlement - payment_response - headers title: AccessX402SettleResponse AccessX402SettlementEvidenceResponse: properties: id: type: string title: Id owner_id: type: string title: Owner Id proof_id: type: string title: Proof Id verification_attempt_id: anyOf: - type: string - type: 'null' title: Verification Attempt Id rail_id: type: string title: Rail Id status: type: string title: Status settlement_reference: anyOf: - type: string - type: 'null' title: Settlement Reference finality_state: anyOf: - type: string - type: 'null' title: Finality State confirmations: anyOf: - type: integer - type: 'null' title: Confirmations settled_at: anyOf: - type: string - type: 'null' title: Settled At evidence: type: object title: Evidence created_at: anyOf: - type: string - type: 'null' title: Created At type: object required: - id - owner_id - proof_id - verification_attempt_id - rail_id - status - settlement_reference - finality_state - confirmations - settled_at - evidence - created_at title: AccessX402SettlementEvidenceResponse AccountAssetSummary: properties: token_mint: anyOf: - type: string - type: 'null' title: Token Mint asset_symbol: type: string title: Asset Symbol asset_decimals: type: integer title: Asset Decimals confirmed_payments: type: integer title: Confirmed Payments gross_minor_units: type: integer title: Gross Minor Units net_minor_units: type: integer title: Net Minor Units fee_minor_units: type: integer title: Fee Minor Units type: object required: - token_mint - asset_symbol - asset_decimals - confirmed_payments - gross_minor_units - net_minor_units - fee_minor_units title: AccountAssetSummary AccountClaims: properties: hilt_score: type: boolean title: Hilt Score hilt_pay: type: boolean title: Hilt Pay hilt_ops: type: boolean title: Hilt Ops merchant_analytics: type: boolean title: Merchant Analytics buy_notifications: type: boolean title: Buy Notifications receipt_exports: type: boolean title: Receipt Exports tax_exports: type: boolean title: Tax Exports custom_checkout_domains: type: boolean title: Custom Checkout Domains is_staff: type: boolean title: Is Staff type: object required: - hilt_score - hilt_pay - hilt_ops - merchant_analytics - buy_notifications - receipt_exports - tax_exports - custom_checkout_domains - is_staff title: AccountClaims AccountResponse: properties: user_id: type: string title: User Id email: anyOf: - type: string - type: 'null' title: Email wallet_address: anyOf: - type: string - type: 'null' title: Wallet Address display_name: anyOf: - type: string - type: 'null' title: Display Name tier: type: string title: Tier status: type: string title: Status email_verified: type: boolean title: Email Verified timezone: type: string title: Timezone created_at: type: string title: Created At key_id: anyOf: - type: string - type: 'null' title: Key Id sandbox: type: boolean title: Sandbox notification_prefs: type: object title: Notification Prefs merchant_settings: type: object title: Merchant Settings claims: $ref: '#/components/schemas/AccountClaims' has_password: type: boolean title: Has Password default: false auth_providers: items: type: string type: array title: Auth Providers type: object required: - user_id - email - wallet_address - display_name - tier - status - email_verified - timezone - created_at - key_id - sandbox - notification_prefs - merchant_settings - claims title: AccountResponse AccountSecurityUpdateRequest: properties: email: anyOf: - type: string format: email - type: 'null' title: Email current_password: anyOf: - type: string - type: 'null' title: Current Password new_password: anyOf: - type: string - type: 'null' title: New Password type: object title: AccountSecurityUpdateRequest AccountSummaryResponse: properties: active_templates: type: integer title: Active Templates paying_members: type: integer title: Paying Members renewals_due: type: integer title: Renewals Due open_support_threads: type: integer title: Open Support Threads receipts_issued: type: integer title: Receipts Issued total_confirmed_payments: type: integer title: Total Confirmed Payments confirmed_payments_today: type: integer title: Confirmed Payments Today overall_assets: items: $ref: '#/components/schemas/AccountAssetSummary' type: array title: Overall Assets today_assets: items: $ref: '#/components/schemas/AccountAssetSummary' type: array title: Today Assets type: object required: - active_templates - paying_members - renewals_due - open_support_threads - receipts_issued - total_confirmed_payments - confirmed_payments_today - overall_assets - today_assets title: AccountSummaryResponse AccountUpdateRequest: properties: display_name: anyOf: - type: string - type: 'null' title: Display Name timezone: anyOf: - type: string - type: 'null' title: Timezone notification_prefs: anyOf: - type: object - type: 'null' title: Notification Prefs merchant_settings: anyOf: - type: object - type: 'null' title: Merchant Settings type: object title: AccountUpdateRequest AddMessageRequest: properties: body: type: string title: Body type: object required: - body title: AddMessageRequest AuthResponse: properties: token: type: string title: Token user_id: type: string title: User Id tier: type: string title: Tier email: anyOf: - type: string - type: 'null' title: Email claims: $ref: '#/components/schemas/EntitlementClaims' type: object required: - token - user_id - tier - email - claims title: AuthResponse AutomaticRenewSetupRequest: properties: payment_id: type: string title: Payment Id type: object required: - payment_id title: AutomaticRenewSetupRequest AutomaticRenewSetupResponse: properties: setup_key: type: string title: Setup Key instructions: items: type: object type: array title: Instructions mandate_message: type: string title: Mandate Message renewal_terms: type: object title: Renewal Terms native_subscription: anyOf: - type: object - type: 'null' title: Native Subscription type: object required: - setup_key - instructions - mandate_message - renewal_terms title: AutomaticRenewSetupResponse BillingAssetSummaryResponse: properties: token_mint: anyOf: - type: string - type: 'null' title: Token Mint asset_symbol: type: string title: Asset Symbol asset_decimals: type: integer title: Asset Decimals confirmed_payments: type: integer title: Confirmed Payments gross_minor_units: type: integer title: Gross Minor Units net_minor_units: type: integer title: Net Minor Units fee_minor_units: type: integer title: Fee Minor Units type: object required: - asset_symbol - asset_decimals - confirmed_payments - gross_minor_units - net_minor_units - fee_minor_units title: BillingAssetSummaryResponse BillingPlanCardResponse: properties: slug: type: string title: Slug label: type: string title: Label description: type: string title: Description monthly_price_usd: anyOf: - type: integer - type: 'null' title: Monthly Price Usd yearly_price_usd: anyOf: - type: integer - type: 'null' title: Yearly Price Usd annual_discount_pct: anyOf: - type: integer - type: 'null' title: Annual Discount Pct transaction_fee_pct: type: number title: Transaction Fee Pct transaction_fee_flat_usd_cents: type: integer title: Transaction Fee Flat Usd Cents live_link_limit: anyOf: - type: integer - type: 'null' title: Live Link Limit seats_included: type: integer title: Seats Included manual_renewals: type: boolean title: Manual Renewals automatic_renewals: type: boolean title: Automatic Renewals merchant_analytics: type: boolean title: Merchant Analytics buy_notifications: type: boolean title: Buy Notifications receipt_exports: type: boolean title: Receipt Exports tax_exports: type: boolean title: Tax Exports custom_checkout_domains: type: boolean title: Custom Checkout Domains type: object required: - slug - label - description - monthly_price_usd - yearly_price_usd - annual_discount_pct - transaction_fee_pct - transaction_fee_flat_usd_cents - live_link_limit - seats_included - manual_renewals - automatic_renewals - merchant_analytics - buy_notifications - receipt_exports - tax_exports - custom_checkout_domains title: BillingPlanCardResponse BillingSummaryResponse: properties: tier: type: string title: Tier billing_status: type: string title: Billing Status billing_interval: type: string title: Billing Interval stripe_customer_id: anyOf: - type: string - type: 'null' title: Stripe Customer Id stripe_subscription_id: anyOf: - type: string - type: 'null' title: Stripe Subscription Id stripe_price_id: anyOf: - type: string - type: 'null' title: Stripe Price Id current_period_start: anyOf: - type: string - type: 'null' title: Current Period Start current_period_end: anyOf: - type: string - type: 'null' title: Current Period End trial_ends_at: anyOf: - type: string - type: 'null' title: Trial Ends At cancel_at_period_end: type: boolean title: Cancel At Period End active_live_links: type: integer title: Active Live Links total_templates: type: integer title: Total Templates live_link_limit: anyOf: - type: integer - type: 'null' title: Live Link Limit can_publish_live: type: boolean title: Can Publish Live transaction_fee_pct: type: number title: Transaction Fee Pct transaction_fee_flat_usd_cents: type: integer title: Transaction Fee Flat Usd Cents plan_monthly_price_usd: anyOf: - type: integer - type: 'null' title: Plan Monthly Price Usd plan_yearly_price_usd: anyOf: - type: integer - type: 'null' title: Plan Yearly Price Usd annual_discount_pct: anyOf: - type: integer - type: 'null' title: Annual Discount Pct stripe_publishable_key: anyOf: - type: string - type: 'null' title: Stripe Publishable Key portal_available: type: boolean title: Portal Available checkout_available: type: boolean title: Checkout Available available_plans: items: $ref: '#/components/schemas/BillingPlanCardResponse' type: array title: Available Plans merchant_total_confirmed_payments: type: integer title: Merchant Total Confirmed Payments merchant_assets: items: $ref: '#/components/schemas/BillingAssetSummaryResponse' type: array title: Merchant Assets gross_usdc_equivalent_minor_units: type: integer title: Gross Usdc Equivalent Minor Units net_usdc_equivalent_minor_units: type: integer title: Net Usdc Equivalent Minor Units fee_usdc_equivalent_minor_units: type: integer title: Fee Usdc Equivalent Minor Units gross_sol_equivalent: type: number title: Gross Sol Equivalent live_sol_price_usd: anyOf: - type: number - type: 'null' title: Live Sol Price Usd stripe_history: items: $ref: '#/components/schemas/StripeInvoiceHistoryResponse' type: array title: Stripe History type: object required: - tier - billing_status - billing_interval - cancel_at_period_end - active_live_links - total_templates - can_publish_live - transaction_fee_pct - transaction_fee_flat_usd_cents - portal_available - checkout_available - available_plans - merchant_total_confirmed_payments - merchant_assets - gross_usdc_equivalent_minor_units - net_usdc_equivalent_minor_units - fee_usdc_equivalent_minor_units - gross_sol_equivalent - stripe_history title: BillingSummaryResponse BroadcastRequest: properties: payment_id: type: string title: Payment Id tx_signature: type: string title: Tx Signature payer_wallet: anyOf: - type: string - type: 'null' title: Payer Wallet wallet_source: anyOf: - type: string - type: 'null' title: Wallet Source type: object required: - payment_id - tx_signature title: BroadcastRequest BroadcastResponse: properties: payment_id: type: string title: Payment Id status: type: string title: Status tx_signature: type: string title: Tx Signature type: object required: - payment_id - status - tx_signature title: BroadcastResponse CheckoutDomain: properties: id: type: string title: Id owner_id: type: string title: Owner Id domain: type: string title: Domain state: type: string title: State verification_dns_name: type: string title: Verification Dns Name verification_dns_value: type: string title: Verification Dns Value cname_target: type: string title: Cname Target dns_checked_at: anyOf: - type: string - type: 'null' title: Dns Checked At dns_verified_at: anyOf: - type: string - type: 'null' title: Dns Verified At certificate_status: type: string title: Certificate Status certificate_requested_at: anyOf: - type: string - type: 'null' title: Certificate Requested At certificate_issued_at: anyOf: - type: string - type: 'null' title: Certificate Issued At activated_at: anyOf: - type: string - type: 'null' title: Activated At paused_at: anyOf: - type: string - type: 'null' title: Paused At failure_reason: anyOf: - type: string - type: 'null' title: Failure Reason routing_enabled: type: boolean title: Routing Enabled created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - owner_id - domain - state - verification_dns_name - verification_dns_value - cname_target - dns_checked_at - dns_verified_at - certificate_status - certificate_requested_at - certificate_issued_at - activated_at - paused_at - failure_reason - routing_enabled - created_at - updated_at title: CheckoutDomain CheckoutDomainCreateResponse: properties: item: $ref: '#/components/schemas/CheckoutDomain' routing_enabled: type: boolean title: Routing Enabled additionalProperties: true type: object required: - item - routing_enabled title: CheckoutDomainCreateResponse CheckoutDomainListResponse: properties: items: items: $ref: '#/components/schemas/CheckoutDomain' type: array title: Items routing_enabled: type: boolean title: Routing Enabled additionalProperties: true type: object required: - items - routing_enabled title: CheckoutDomainListResponse CheckoutDomainRequest: properties: domain: type: string maxLength: 253 minLength: 3 title: Domain type: object required: - domain title: CheckoutDomainRequest CheckoutHandoffCreateRequest: properties: identity_value: type: string maxLength: 160 minLength: 1 title: Identity Value identity_display: anyOf: - type: string maxLength: 160 - type: 'null' title: Identity Display identity_type: anyOf: - type: string - type: 'null' title: Identity Type return_url: anyOf: - type: string maxLength: 2048 - type: 'null' title: Return Url expires_in_minutes: type: integer maximum: 1440 minimum: 1 title: Expires In Minutes default: 30 type: object required: - identity_value title: CheckoutHandoffCreateRequest CheckoutHandoffResolveRequest: properties: handoff_token: type: string minLength: 1 title: Handoff Token type: object required: - handoff_token title: CheckoutHandoffResolveRequest CheckoutHandoffResponse: properties: handoff_token: anyOf: - type: string - type: 'null' title: Handoff Token expires_at: type: string title: Expires At identity_type: anyOf: - type: string - type: 'null' title: Identity Type identity_value: anyOf: - type: string - type: 'null' title: Identity Value identity_display: anyOf: - type: string - type: 'null' title: Identity Display return_url: anyOf: - type: string - type: 'null' title: Return Url checkout_url: anyOf: - type: string - type: 'null' title: Checkout Url product_id: anyOf: - type: string - type: 'null' title: Product Id slug: anyOf: - type: string - type: 'null' title: Slug additionalProperties: true type: object required: - expires_at title: CheckoutHandoffResponse CheckoutPaymentSessionResponse: properties: payment_id: type: string title: Payment Id nonce: type: string title: Nonce amount_minor_units: type: integer title: Amount Minor Units merchant_amount_minor_units: type: integer title: Merchant Amount Minor Units fee_minor_units: type: integer title: Fee Minor Units fee_wallet: type: string title: Fee Wallet token_mint: type: string title: Token Mint asset_symbol: type: string title: Asset Symbol asset_decimals: type: integer title: Asset Decimals merchant_wallet: type: string title: Merchant Wallet expires_at: type: string title: Expires At status: type: string title: Status phantom_mobile: anyOf: - type: object - type: 'null' title: Phantom Mobile additionalProperties: true type: object required: - payment_id - nonce - amount_minor_units - merchant_amount_minor_units - fee_minor_units - fee_wallet - token_mint - asset_symbol - asset_decimals - merchant_wallet - expires_at - status - phantom_mobile title: CheckoutPaymentSessionResponse ConfirmRequest: properties: slug: anyOf: - type: string - type: 'null' title: Slug product_id: anyOf: - type: string - type: 'null' title: Product Id tx_signature: type: string title: Tx Signature payer_wallet: type: string title: Payer Wallet wallet_source: anyOf: - type: string - type: 'null' title: Wallet Source identity_session_id: anyOf: - type: string - type: 'null' title: Identity Session Id customer_reference_type: anyOf: - type: string - type: 'null' title: Customer Reference Type customer_reference_value: anyOf: - type: string - type: 'null' title: Customer Reference Value customer_reference_display: anyOf: - type: string - type: 'null' title: Customer Reference Display payment_id: anyOf: - type: string - type: 'null' title: Payment Id automatic_renew_setup_key: anyOf: - type: string - type: 'null' title: Automatic Renew Setup Key automatic_renew_message_signature_b64: anyOf: - type: string - type: 'null' title: Automatic Renew Message Signature B64 automatic_renew_native_setup_signature: anyOf: - type: string - type: 'null' title: Automatic Renew Native Setup Signature automatic_renew_native_subscription_authority_pda: anyOf: - type: string - type: 'null' title: Automatic Renew Native Subscription Authority Pda automatic_renew_native_subscription_pda: anyOf: - type: string - type: 'null' title: Automatic Renew Native Subscription Pda automatic_renew_native_plan_pda: anyOf: - type: string - type: 'null' title: Automatic Renew Native Plan Pda automatic_renew_native_payer_token_account: anyOf: - type: string - type: 'null' title: Automatic Renew Native Payer Token Account type: object required: - tx_signature - payer_wallet title: ConfirmRequest ConfirmResponse: properties: status: type: string title: Status payment_id: type: string title: Payment Id delivery_type: anyOf: - type: string - type: 'null' title: Delivery Type delivery_value: anyOf: - type: string - type: 'null' title: Delivery Value amount_minor_units: type: integer title: Amount Minor Units delivery_status: anyOf: - type: string - type: 'null' title: Delivery Status membership_id: anyOf: - type: string - type: 'null' title: Membership Id membership_status: anyOf: - type: string - type: 'null' title: Membership Status membership_period_end_at: anyOf: - type: string - type: 'null' title: Membership Period End At automatic_renew_setup_status: anyOf: - type: string - type: 'null' title: Automatic Renew Setup Status automatic_renew_setup_error: anyOf: - type: string - type: 'null' title: Automatic Renew Setup Error type: object required: - status - payment_id - amount_minor_units title: ConfirmResponse ConnectRequest: properties: payer_wallet: anyOf: - type: string - type: 'null' title: Payer Wallet amount_minor_units: anyOf: - type: integer exclusiveMinimum: 0 - type: 'null' title: Amount Minor Units identity_session_id: anyOf: - type: string - type: 'null' title: Identity Session Id customer_reference_type: anyOf: - type: string - type: 'null' title: Customer Reference Type customer_reference_value: anyOf: - type: string maxLength: 160 - type: 'null' title: Customer Reference Value customer_reference_display: anyOf: - type: string maxLength: 160 - type: 'null' title: Customer Reference Display handoff_token: anyOf: - type: string maxLength: 4096 - type: 'null' title: Handoff Token type: object title: ConnectRequest ConnectorAuthorizationComplete: properties: request: type: string maxLength: 8000 minLength: 20 title: Request approved: type: boolean title: Approved default: true type: object required: - request title: ConnectorAuthorizationComplete ConnectorAuthorizationRedirectResponse: properties: redirectUrl: type: string title: Redirecturl type: object required: - redirectUrl title: ConnectorAuthorizationRedirectResponse ConnectorAuthorizationResponse: properties: client: $ref: '#/components/schemas/ConnectorClientSummary' scopes: items: type: string type: array title: Scopes requiresX: type: boolean title: Requiresx requiresWallet: type: boolean title: Requireswallet identity: anyOf: - type: object - type: 'null' title: Identity profile: anyOf: - type: object - type: 'null' title: Profile zeroCustody: $ref: '#/components/schemas/ConnectorZeroCustodySummary' type: object required: - client - scopes - requiresX - requiresWallet - identity - profile - zeroCustody title: ConnectorAuthorizationResponse ConnectorClientSummary: properties: id: type: string title: Id name: type: string title: Name redirectHost: type: string title: Redirecthost default: '' type: object required: - id - name title: ConnectorClientSummary ConnectorConnectionListResponse: properties: connections: items: $ref: '#/components/schemas/ConnectorConnectionResponse' type: array title: Connections type: object required: - connections title: ConnectorConnectionListResponse ConnectorConnectionResponse: properties: id: type: string title: Id client: $ref: '#/components/schemas/ConnectorClientSummary' scopes: items: type: string type: array title: Scopes connectedAt: type: string title: Connectedat lastUsedAt: type: string title: Lastusedat type: object required: - id - client - scopes - connectedAt - lastUsedAt title: ConnectorConnectionResponse ConnectorZeroCustodySummary: properties: canPrepare: type: boolean title: Canprepare canSign: type: boolean title: Cansign walletApprovalRequired: type: boolean title: Walletapprovalrequired type: object required: - canPrepare - canSign - walletApprovalRequired title: ConnectorZeroCustodySummary CreateKeyRequest: properties: name: type: string title: Name sandbox_mode: type: boolean title: Sandbox Mode default: false permissions: items: type: string type: array title: Permissions default: - read - execute type: object required: - name title: CreateKeyRequest CreateKeyResponse: properties: key: $ref: '#/components/schemas/KeySummary' raw_key: type: string title: Raw Key type: object required: - key - raw_key title: CreateKeyResponse CreateProductRequest: properties: product_type: type: string title: Product Type title: type: string maxLength: 120 minLength: 1 title: Title description: anyOf: - type: string - type: 'null' title: Description image_url: anyOf: - type: string - type: 'null' title: Image Url amount_minor_units: anyOf: - type: integer exclusiveMinimum: 0 - type: 'null' title: Amount Minor Units token_mint: anyOf: - type: string - type: 'null' title: Token Mint merchant_wallet: type: string title: Merchant Wallet delivery_type: type: string title: Delivery Type default: NONE delivery_value: anyOf: - type: string - type: 'null' title: Delivery Value tip_presets_lamports: anyOf: - items: type: integer type: array - type: 'null' title: Tip Presets Lamports max_payments: anyOf: - type: integer exclusiveMinimum: 0 - type: 'null' title: Max Payments membership_config: anyOf: - $ref: '#/components/schemas/MembershipConfigRequest' - type: 'null' type: object required: - product_type - title - merchant_wallet title: CreateProductRequest CreateTicketRequest: properties: subject: type: string title: Subject category: type: string title: Category default: OTHER body: type: string title: Body context: anyOf: - type: object - type: 'null' title: Context type: object required: - subject - body title: CreateTicketRequest DeliveryReadinessDefaults: properties: payout_wallet_configured: type: boolean title: Payout Wallet Configured default_redirect_url_configured: type: boolean title: Default Redirect Url Configured default_support_url_configured: type: boolean title: Default Support Url Configured additionalProperties: true type: object required: - payout_wallet_configured - default_redirect_url_configured - default_support_url_configured title: DeliveryReadinessDefaults DeliveryReadinessResponse: properties: merchant_name: anyOf: - type: string - type: 'null' title: Merchant Name overall_status: type: string title: Overall Status active_membership_templates: type: integer title: Active Membership Templates defaults: $ref: '#/components/schemas/DeliveryReadinessDefaults' platforms: additionalProperties: type: object type: object title: Platforms blockers: items: type: string type: array title: Blockers warnings: items: type: string type: array title: Warnings checked_at: type: string title: Checked At additionalProperties: true type: object required: - merchant_name - overall_status - active_membership_templates - defaults - platforms - blockers - warnings - checked_at title: DeliveryReadinessResponse DeliveryTestRequest: properties: provider: type: string title: Provider type: object required: - provider title: DeliveryTestRequest DeliveryTestResponse: properties: provider: type: string title: Provider status: type: string title: Status summary: type: string title: Summary checks: items: type: object type: array title: Checks checked_at: type: string title: Checked At additionalProperties: true type: object required: - provider - status - summary - checks - checked_at title: DeliveryTestResponse DetailResponse: properties: detail: type: string title: Detail additionalProperties: true type: object required: - detail title: DetailResponse EntitlementClaims: properties: hilt_score: type: boolean title: Hilt Score hilt_pay: type: boolean title: Hilt Pay hilt_ops: type: boolean title: Hilt Ops merchant_analytics: type: boolean title: Merchant Analytics buy_notifications: type: boolean title: Buy Notifications receipt_exports: type: boolean title: Receipt Exports tax_exports: type: boolean title: Tax Exports custom_checkout_domains: type: boolean title: Custom Checkout Domains is_staff: type: boolean title: Is Staff type: object required: - hilt_score - hilt_pay - hilt_ops - merchant_analytics - buy_notifications - receipt_exports - tax_exports - custom_checkout_domains - is_staff title: EntitlementClaims HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError HealthCheck: properties: status: type: string title: Status detail: anyOf: - type: string - type: 'null' title: Detail additionalProperties: true type: object required: - status title: HealthCheck HealthChecks: properties: database: $ref: '#/components/schemas/HealthCheck' redis: $ref: '#/components/schemas/HealthCheck' additionalProperties: true type: object required: - database - redis title: HealthChecks HealthResponse: properties: status: type: string title: Status service: type: string title: Service version: type: string title: Version checks: $ref: '#/components/schemas/HealthChecks' additionalProperties: true type: object required: - status - service - version - checks title: HealthResponse HiltProductReference: properties: id: type: string title: Id slug: anyOf: - type: string - type: 'null' title: Slug status: anyOf: - type: string - type: 'null' title: Status title: anyOf: - type: string - type: 'null' title: Title token_mint: anyOf: - type: string - type: 'null' title: Token Mint checkout_url: type: string title: Checkout Url additionalProperties: true type: object required: - id - slug - status - title - token_mint - checkout_url title: HiltProductReference IdentityHandshakeCompleteRequest: properties: session_id: type: string title: Session Id wallet_address: type: string title: Wallet Address signed_message_b64: type: string title: Signed Message B64 type: object required: - session_id - wallet_address - signed_message_b64 title: IdentityHandshakeCompleteRequest IdentityHandshakeCompleteResponse: properties: session_id: type: string title: Session Id status: type: string title: Status wallet_address: type: string title: Wallet Address wallet_source: type: string title: Wallet Source identity_type: type: string title: Identity Type identity_value: type: string title: Identity Value identity_display: anyOf: - type: string - type: 'null' title: Identity Display verified_at: type: string title: Verified At expires_at: type: string title: Expires At type: object required: - session_id - status - wallet_address - wallet_source - identity_type - identity_value - verified_at - expires_at title: IdentityHandshakeCompleteResponse IdentityHandshakeStartRequest: properties: slug: type: string title: Slug wallet_address: type: string title: Wallet Address wallet_source: anyOf: - type: string - type: 'null' title: Wallet Source customer_reference_type: anyOf: - type: string - type: 'null' title: Customer Reference Type customer_reference_value: type: string title: Customer Reference Value customer_reference_display: anyOf: - type: string - type: 'null' title: Customer Reference Display type: object required: - slug - wallet_address - customer_reference_value title: IdentityHandshakeStartRequest IdentityHandshakeStartResponse: properties: session_id: type: string title: Session Id status: type: string title: Status wallet_address: type: string title: Wallet Address wallet_source: type: string title: Wallet Source identity_type: type: string title: Identity Type identity_value: type: string title: Identity Value identity_display: anyOf: - type: string - type: 'null' title: Identity Display challenge_message: type: string title: Challenge Message expires_at: type: string title: Expires At type: object required: - session_id - status - wallet_address - wallet_source - identity_type - identity_value - challenge_message - expires_at title: IdentityHandshakeStartResponse IntegrationApiKey: properties: key_id: anyOf: - type: string - type: 'null' title: Key Id permissions: items: type: string type: array title: Permissions has_read: type: boolean title: Has Read has_execute: type: boolean title: Has Execute minimum_scopes: items: type: string type: array title: Minimum Scopes additionalProperties: true type: object required: - key_id - permissions - has_read - has_execute - minimum_scopes title: IntegrationApiKey IntegrationEventsResponse: properties: total: type: integer title: Total page: type: integer title: Page events: items: $ref: '#/components/schemas/WebhookEvent' type: array title: Events supported_events: items: type: string type: array title: Supported Events per_page: type: integer title: Per Page additionalProperties: true type: object required: - total - page - events - supported_events - per_page title: IntegrationEventsResponse IntegrationHealthResponse: properties: ok: type: boolean title: Ok api_version: type: string title: Api Version workspace: $ref: '#/components/schemas/IntegrationWorkspace' api_key: $ref: '#/components/schemas/IntegrationApiKey' rate_limit: $ref: '#/components/schemas/IntegrationRateLimit' webhooks: $ref: '#/components/schemas/IntegrationWebhookCapabilities' additionalProperties: true type: object required: - ok - api_version - workspace - api_key - rate_limit - webhooks title: IntegrationHealthResponse IntegrationRateLimit: properties: requests_per_minute: type: integer title: Requests Per Minute headers: items: type: string type: array title: Headers additionalProperties: true type: object required: - requests_per_minute - headers title: IntegrationRateLimit IntegrationWebhookCapabilities: properties: supported_events: items: type: string type: array title: Supported Events event_id_header: type: string title: Event Id Header signature_header: type: string title: Signature Header timestamp_header: type: string title: Timestamp Header zapier_active_hook_limit: type: integer title: Zapier Active Hook Limit additionalProperties: true type: object required: - supported_events - event_id_header - signature_header - timestamp_header - zapier_active_hook_limit title: IntegrationWebhookCapabilities IntegrationWorkspace: properties: user_id: type: string title: User Id tier: type: string title: Tier sandbox: type: boolean title: Sandbox hilt_pay: type: boolean title: Hilt Pay additionalProperties: true type: object required: - user_id - tier - sandbox - hilt_pay title: IntegrationWorkspace KeyActivityItem: properties: endpoint: type: string title: Endpoint http_method: type: string title: Http Method status_code: type: integer title: Status Code credits_burned: type: integer title: Credits Burned duration_ms: anyOf: - type: integer - type: 'null' title: Duration Ms error_message: anyOf: - type: string - type: 'null' title: Error Message created_at: type: string title: Created At type: object required: - endpoint - http_method - status_code - credits_burned - duration_ms - error_message - created_at title: KeyActivityItem KeySummary: properties: id: type: string title: Id name: type: string title: Name key_prefix: type: string title: Key Prefix permissions: items: type: string type: array title: Permissions sandbox_mode: type: boolean title: Sandbox Mode last_used_at: anyOf: - type: string - type: 'null' title: Last Used At created_at: type: string title: Created At revoked_at: anyOf: - type: string - type: 'null' title: Revoked At usage_summary: $ref: '#/components/schemas/KeyUsageSummary' default: total_calls: 0 success_calls: 0 error_calls: 0 credits_burned: 0 recent_activity: items: $ref: '#/components/schemas/KeyActivityItem' type: array title: Recent Activity default: [] type: object required: - id - name - key_prefix - permissions - sandbox_mode - last_used_at - created_at - revoked_at title: KeySummary KeyUsageSummary: properties: total_calls: type: integer title: Total Calls default: 0 success_calls: type: integer title: Success Calls default: 0 error_calls: type: integer title: Error Calls default: 0 credits_burned: type: integer title: Credits Burned default: 0 latest_activity_at: anyOf: - type: string - type: 'null' title: Latest Activity At latest_endpoint: anyOf: - type: string - type: 'null' title: Latest Endpoint type: object title: KeyUsageSummary LoginRequest: properties: email: type: string format: email title: Email password: type: string title: Password type: object required: - email - password title: LoginRequest Membership: properties: id: type: string title: Id product_id: type: string title: Product Id owner_id: type: string title: Owner Id platform: type: string title: Platform platform_user_id: type: string title: Platform User Id platform_display: anyOf: - type: string - type: 'null' title: Platform Display customer_identity_type: type: string title: Customer Identity Type customer_identity_value: type: string title: Customer Identity Value payer_wallet: anyOf: - type: string - type: 'null' title: Payer Wallet status: type: string title: Status current_period_start_at: anyOf: - type: string - type: 'null' title: Current Period Start At current_period_end_at: anyOf: - type: string - type: 'null' title: Current Period End At grace_ends_at: anyOf: - type: string - type: 'null' title: Grace Ends At latest_payment_id: anyOf: - type: string - type: 'null' title: Latest Payment Id latest_tx_signature: anyOf: - type: string - type: 'null' title: Latest Tx Signature delivery_status: type: string title: Delivery Status delivery_last_error: anyOf: - type: string - type: 'null' title: Delivery Last Error renewal_count: type: integer title: Renewal Count last_reminder_sent_at: anyOf: - type: string - type: 'null' title: Last Reminder Sent At metadata_json: type: object title: Metadata Json created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - product_id - owner_id - platform - platform_user_id - platform_display - customer_identity_type - customer_identity_value - payer_wallet - status - current_period_start_at - current_period_end_at - grace_ends_at - latest_payment_id - latest_tx_signature - delivery_status - delivery_last_error - renewal_count - last_reminder_sent_at - metadata_json - created_at - updated_at title: Membership MembershipConfigRequest: properties: enabled: type: boolean title: Enabled default: true platform: anyOf: - type: string - type: 'null' title: Platform access_mode: anyOf: - type: string - type: 'null' title: Access Mode identity_type: anyOf: - type: string - type: 'null' title: Identity Type identity_label: anyOf: - type: string - type: 'null' title: Identity Label identity_required: anyOf: - type: boolean - type: 'null' title: Identity Required renewal_mode: anyOf: - type: string - type: 'null' title: Renewal Mode billing_interval_days: anyOf: - type: integer maximum: 3660 exclusiveMinimum: 0 - type: 'null' title: Billing Interval Days grace_period_days: anyOf: - type: integer maximum: 365 minimum: 0 - type: 'null' title: Grace Period Days renewal_reminder_offsets_days: anyOf: - items: type: integer type: array - type: 'null' title: Renewal Reminder Offsets Days platform_target_id: anyOf: - type: string - type: 'null' title: Platform Target Id platform_target_label: anyOf: - type: string - type: 'null' title: Platform Target Label allow_multiple_active: anyOf: - type: boolean - type: 'null' title: Allow Multiple Active settings_json: anyOf: - type: object - type: 'null' title: Settings Json type: object title: MembershipConfigRequest MembershipDeliveryDiagnosticsResponse: properties: membership_id: type: string title: Membership Id owner_id: type: string title: Owner Id product_id: type: string title: Product Id product_title: anyOf: - type: string - type: 'null' title: Product Title product_slug: anyOf: - type: string - type: 'null' title: Product Slug platform: type: string title: Platform platform_user_id: anyOf: - type: string - type: 'null' title: Platform User Id platform_display: anyOf: - type: string - type: 'null' title: Platform Display membership_status: anyOf: - type: string - type: 'null' title: Membership Status delivery_status: anyOf: - type: string - type: 'null' title: Delivery Status delivery_last_error: anyOf: - type: string - type: 'null' title: Delivery Last Error latest_payment_id: anyOf: - type: string - type: 'null' title: Latest Payment Id latest_tx_signature: anyOf: - type: string - type: 'null' title: Latest Tx Signature automation_ready: type: boolean title: Automation Ready fallback_ready: type: boolean title: Fallback Ready fallback_value: anyOf: - type: string - type: 'null' title: Fallback Value overall_status: type: string title: Overall Status summary: type: string title: Summary provider_state: type: object title: Provider State checks: items: type: object type: array title: Checks actions: additionalProperties: type: boolean type: object title: Actions generated_at: type: string title: Generated At additionalProperties: true type: object required: - membership_id - owner_id - product_id - product_title - product_slug - platform - platform_user_id - platform_display - membership_status - delivery_status - delivery_last_error - latest_payment_id - latest_tx_signature - automation_ready - fallback_ready - fallback_value - overall_status - summary - provider_state - checks - actions - generated_at title: MembershipDeliveryDiagnosticsResponse MembershipDeliveryResponse: properties: membership: $ref: '#/components/schemas/Membership' delivery: type: object title: Delivery additionalProperties: true type: object required: - membership - delivery title: MembershipDeliveryResponse MembershipDetailResponse: properties: membership: $ref: '#/components/schemas/Membership' periods: items: $ref: '#/components/schemas/MembershipPeriod' type: array title: Periods events: items: $ref: '#/components/schemas/MembershipEvent' type: array title: Events auto_renew: anyOf: - type: object - type: 'null' title: Auto Renew additionalProperties: true type: object required: - membership - periods - events - auto_renew title: MembershipDetailResponse MembershipEvent: properties: id: type: integer title: Id membership_id: type: string title: Membership Id payment_id: anyOf: - type: string - type: 'null' title: Payment Id event_type: type: string title: Event Type actor_type: type: string title: Actor Type actor_id: anyOf: - type: string - type: 'null' title: Actor Id payload_json: type: object title: Payload Json created_at: anyOf: - type: string - type: 'null' title: Created At additionalProperties: true type: object required: - id - membership_id - payment_id - event_type - actor_type - actor_id - payload_json - created_at title: MembershipEvent MembershipGiftRequest: properties: days: type: integer title: Days note: type: string title: Note default: '' type: object required: - days title: MembershipGiftRequest MembershipListResponse: properties: items: items: $ref: '#/components/schemas/Membership' type: array title: Items count: type: integer title: Count additionalProperties: true type: object required: - items - count title: MembershipListResponse MembershipNotesRequest: properties: notes: type: string title: Notes default: '' type: object title: MembershipNotesRequest MembershipPeriod: properties: id: type: string title: Id membership_id: type: string title: Membership Id payment_id: anyOf: - type: string - type: 'null' title: Payment Id tx_signature: anyOf: - type: string - type: 'null' title: Tx Signature amount_lamports: type: integer title: Amount Lamports token_mint: type: string title: Token Mint period_start_at: anyOf: - type: string - type: 'null' title: Period Start At period_end_at: anyOf: - type: string - type: 'null' title: Period End At status: type: string title: Status activated_at: anyOf: - type: string - type: 'null' title: Activated At revoked_at: anyOf: - type: string - type: 'null' title: Revoked At created_at: anyOf: - type: string - type: 'null' title: Created At additionalProperties: true type: object required: - id - membership_id - payment_id - tx_signature - amount_lamports - token_mint - period_start_at - period_end_at - status - activated_at - revoked_at - created_at title: MembershipPeriod MembershipProfileRequest: properties: platform_display: type: string title: Platform Display default: '' type: object title: MembershipProfileRequest MembershipReactivationResponse: properties: membership_id: type: string title: Membership Id product_title: type: string title: Product Title product_slug: type: string title: Product Slug amount_minor_units: type: integer title: Amount Minor Units amount_display: type: string title: Amount Display token_mint: type: string title: Token Mint billing_interval_days: type: integer title: Billing Interval Days access_period: type: string title: Access Period membership_started_at: anyOf: - type: string - type: 'null' title: Membership Started At merchant_name: type: string title: Merchant Name merchant_wallet_preview: type: string title: Merchant Wallet Preview access_target_label: anyOf: - type: string - type: 'null' title: Access Target Label renewal_url: type: string title: Renewal Url reactivation_url: type: string title: Reactivation Url templates: type: object title: Templates generated_at: type: string title: Generated At additionalProperties: true type: object required: - membership_id - product_title - product_slug - amount_minor_units - amount_display - token_mint - billing_interval_days - access_period - membership_started_at - merchant_name - merchant_wallet_preview - access_target_label - renewal_url - reactivation_url - templates - generated_at title: MembershipReactivationResponse MembershipRenewalIntelligenceResponse: properties: summary: type: object title: Summary expiring_memberships: items: type: object type: array title: Expiring Memberships product_reports: items: type: object type: array title: Product Reports recent_events: items: $ref: '#/components/schemas/MembershipEvent' type: array title: Recent Events generated_at: type: string title: Generated At additionalProperties: true type: object required: - summary - expiring_memberships - product_reports - recent_events - generated_at title: MembershipRenewalIntelligenceResponse MembershipSupportTicketResponse: properties: ticket_id: type: string title: Ticket Id created: type: boolean title: Created additionalProperties: true type: object required: - ticket_id - created title: MembershipSupportTicketResponse NativeSubscriptionAuthorization: properties: id: type: string title: Id owner_id: type: string title: Owner Id product_id: type: string title: Product Id membership_id: anyOf: - type: string - type: 'null' title: Membership Id initial_payment_id: anyOf: - type: string - type: 'null' title: Initial Payment Id native_plan_id: anyOf: - type: string - type: 'null' title: Native Plan Id latest_collection_attempt_id: anyOf: - type: string - type: 'null' title: Latest Collection Attempt Id payer_wallet: type: string title: Payer Wallet payer_token_account: anyOf: - type: string - type: 'null' title: Payer Token Account subscription_authority_pda: anyOf: - type: string - type: 'null' title: Subscription Authority Pda subscription_pda: anyOf: - type: string - type: 'null' title: Subscription Pda plan_pda: anyOf: - type: string - type: 'null' title: Plan Pda token_mint: type: string title: Token Mint amount_minor_units: type: integer title: Amount Minor Units period_hours: type: integer title: Period Hours next_collection_due_at: anyOf: - type: string - type: 'null' title: Next Collection Due At last_collection_at: anyOf: - type: string - type: 'null' title: Last Collection At status: type: string title: Status setup_signature: anyOf: - type: string - type: 'null' title: Setup Signature cancellation_signature: anyOf: - type: string - type: 'null' title: Cancellation Signature settings_json: type: object title: Settings Json created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - owner_id - product_id - membership_id - initial_payment_id - native_plan_id - latest_collection_attempt_id - payer_wallet - payer_token_account - subscription_authority_pda - subscription_pda - plan_pda - token_mint - amount_minor_units - period_hours - next_collection_due_at - last_collection_at - status - setup_signature - cancellation_signature - settings_json - created_at - updated_at title: NativeSubscriptionAuthorization NativeSubscriptionCancelConfirmRequest: properties: cancel_tx_signature: anyOf: - type: string maxLength: 255 minLength: 16 - type: 'null' title: Cancel Tx Signature revoke_tx_signature: anyOf: - type: string maxLength: 255 minLength: 16 - type: 'null' title: Revoke Tx Signature reason: anyOf: - type: string maxLength: 500 - type: 'null' title: Reason immediate_revoke: type: boolean title: Immediate Revoke default: false verify_onchain: type: boolean title: Verify Onchain default: true type: object title: NativeSubscriptionCancelConfirmRequest NativeSubscriptionCancelIntentRequest: properties: reason: anyOf: - type: string maxLength: 500 - type: 'null' title: Reason cancel_at_period_end: type: boolean title: Cancel At Period End default: true type: object title: NativeSubscriptionCancelIntentRequest NativeSubscriptionCancelRequirement: properties: payment_protocol: type: string title: Payment Protocol action: type: string title: Action program_id: type: string title: Program Id token_mint: type: string title: Token Mint payer_wallet: type: string title: Payer Wallet subscription_authority_pda: anyOf: - type: string - type: 'null' title: Subscription Authority Pda subscription_pda: anyOf: - type: string - type: 'null' title: Subscription Pda plan_pda: anyOf: - type: string - type: 'null' title: Plan Pda user_signed_action: type: string title: User Signed Action close_authority_note: type: string title: Close Authority Note required_confirmation_fields: items: type: string type: array title: Required Confirmation Fields additionalProperties: true type: object required: - payment_protocol - action - program_id - token_mint - payer_wallet - subscription_authority_pda - subscription_pda - plan_pda - user_signed_action - close_authority_note - required_confirmation_fields title: NativeSubscriptionCancelRequirement NativeSubscriptionCancelResponse: properties: status: type: string title: Status authorization: $ref: '#/components/schemas/NativeSubscriptionAuthorization' cancel_policy: type: object title: Cancel Policy cancel_requirement: anyOf: - $ref: '#/components/schemas/NativeSubscriptionCancelRequirement' - type: 'null' cancel_verification: anyOf: - type: object - type: 'null' title: Cancel Verification additionalProperties: true type: object required: - status - authorization - cancel_policy title: NativeSubscriptionCancelResponse NativeSubscriptionMembership: properties: id: anyOf: - type: string - type: 'null' title: Id status: anyOf: - type: string - type: 'null' title: Status current_period_start_at: anyOf: - type: string - type: 'null' title: Current Period Start At current_period_end_at: anyOf: - type: string - type: 'null' title: Current Period End At platform: anyOf: - type: string - type: 'null' title: Platform platform_display: anyOf: - type: string - type: 'null' title: Platform Display additionalProperties: true type: object required: - id - status - current_period_start_at - current_period_end_at - platform - platform_display title: NativeSubscriptionMembership NativeSubscriptionReference: properties: id: type: string title: Id slug: anyOf: - type: string - type: 'null' title: Slug title: anyOf: - type: string - type: 'null' title: Title additionalProperties: true type: object required: - id - slug - title title: NativeSubscriptionReference NativeSubscriptionResponse: properties: authorization: $ref: '#/components/schemas/NativeSubscriptionAuthorization' product: $ref: '#/components/schemas/NativeSubscriptionReference' membership: $ref: '#/components/schemas/NativeSubscriptionMembership' cancel_requirement: anyOf: - $ref: '#/components/schemas/NativeSubscriptionCancelRequirement' - type: 'null' additionalProperties: true type: object required: - authorization - product - membership - cancel_requirement title: NativeSubscriptionResponse OAuthProviderInfo: properties: enabled: type: boolean title: Enabled callback_url: type: string title: Callback Url app_base_url: type: string title: App Base Url uses_app_secret_fallback: type: boolean title: Uses App Secret Fallback default: false missing: items: type: string type: array title: Missing type: object required: - enabled - callback_url - app_base_url - missing title: OAuthProviderInfo OAuthProviderStatusResponse: properties: google: $ref: '#/components/schemas/OAuthProviderInfo' github: $ref: '#/components/schemas/OAuthProviderInfo' x: $ref: '#/components/schemas/OAuthProviderInfo' type: object required: - google - github - x title: OAuthProviderStatusResponse OAuthStartResponse: properties: provider: type: string title: Provider callback_url: type: string title: Callback Url authorization_url: type: string title: Authorization Url type: object required: - provider - callback_url - authorization_url title: OAuthStartResponse PayMeAgentAssetResponse: properties: mint: type: string title: Mint symbol: type: string title: Symbol name: type: string title: Name decimals: type: integer title: Decimals type: object required: - mint - symbol - name - decimals title: PayMeAgentAssetResponse PayMeAgentPaymentCreate: properties: xHandle: type: string maxLength: 16 minLength: 1 title: Xhandle amount: type: string maxLength: 40 minLength: 1 title: Amount asset: type: string pattern: ^(?i:USDC|SOL)$ title: Asset default: USDC note: type: string maxLength: 240 title: Note default: '' idempotencyKey: type: string maxLength: 128 title: Idempotencykey default: '' type: object required: - xHandle - amount title: PayMeAgentPaymentCreate PayMeAgentPaymentEnvelope: properties: payment: $ref: '#/components/schemas/PayMeAgentPaymentResponse' type: object required: - payment title: PayMeAgentPaymentEnvelope PayMeAgentPaymentRequiredResponse: properties: type: type: string title: Type title: type: string title: Title detail: type: string title: Detail payment: $ref: '#/components/schemas/PayMeAgentPaymentResponse' challenge: additionalProperties: type: string type: object title: Challenge type: object required: - type - title - detail - payment - challenge title: PayMeAgentPaymentRequiredResponse PayMeAgentPaymentResponse: properties: id: type: string title: Id status: type: string title: Status protocol: type: string title: Protocol recipient: $ref: '#/components/schemas/PayMeAgentRecipientResponse' asset: $ref: '#/components/schemas/PayMeAgentAssetResponse' quote: $ref: '#/components/schemas/PayMeAgentQuoteResponse' note: type: string title: Note expiresAt: type: string title: Expiresat createdAt: type: string title: Createdat receipt: anyOf: - $ref: '#/components/schemas/PayMeAgentReceiptResponse' - type: 'null' type: object required: - id - status - protocol - recipient - asset - quote - note - expiresAt - createdAt - receipt title: PayMeAgentPaymentResponse PayMeAgentQuoteResponse: properties: recipientAmount: type: string title: Recipientamount hiltFeeAmount: type: string title: Hiltfeeamount buyerAmount: type: string title: Buyeramount platformFeeBps: type: integer title: Platformfeebps feePaidBy: type: string title: Feepaidby type: object required: - recipientAmount - hiltFeeAmount - buyerAmount - platformFeeBps - feePaidBy title: PayMeAgentQuoteResponse PayMeAgentReceiptResponse: properties: id: type: string title: Id receiptNumber: type: string title: Receiptnumber status: type: string title: Status protocol: type: string title: Protocol network: type: string title: Network payerWallet: type: string title: Payerwallet recipientName: type: string title: Recipientname recipientXHandle: type: string title: Recipientxhandle recipientWallet: type: string title: Recipientwallet tokenMint: type: string title: Tokenmint tokenSymbol: type: string title: Tokensymbol tokenDecimals: type: integer title: Tokendecimals recipientAmount: type: string title: Recipientamount hiltFeeAmount: type: string title: Hiltfeeamount checkoutAmount: type: string title: Checkoutamount platformFeeBps: type: integer title: Platformfeebps txSignature: type: string title: Txsignature solscanUrl: type: string title: Solscanurl completedAt: type: string title: Completedat type: object required: - id - receiptNumber - status - protocol - network - payerWallet - recipientName - recipientXHandle - recipientWallet - tokenMint - tokenSymbol - tokenDecimals - recipientAmount - hiltFeeAmount - checkoutAmount - platformFeeBps - txSignature - solscanUrl - completedAt title: PayMeAgentReceiptResponse PayMeAgentRecipientResponse: properties: name: type: string title: Name xHandle: type: string title: Xhandle recipientWallet: type: string title: Recipientwallet identityVerified: type: boolean title: Identityverified walletVerified: type: boolean title: Walletverified type: object required: - name - xHandle - recipientWallet - identityVerified - walletVerified title: PayMeAgentRecipientResponse PayMeAuthenticatorConfirm: properties: enrollmentId: type: string maxLength: 128 minLength: 32 title: Enrollmentid code: type: string maxLength: 20 minLength: 6 title: Code recipientWallet: type: string maxLength: 64 title: Recipientwallet default: '' setupMessage: type: string maxLength: 2000 title: Setupmessage default: '' setupSignature: type: string maxLength: 200 title: Setupsignature default: '' type: object required: - enrollmentId - code title: PayMeAuthenticatorConfirm PayMeAuthenticatorConfirmResponse: properties: authenticatorEnabled: type: boolean title: Authenticatorenabled recoveryCodes: items: type: string type: array title: Recoverycodes recoveryCodesRemaining: type: integer title: Recoverycodesremaining type: object required: - authenticatorEnabled - recoveryCodes - recoveryCodesRemaining title: PayMeAuthenticatorConfirmResponse PayMeAuthenticatorEnrollmentResponse: properties: enrollmentId: type: string title: Enrollmentid status: type: string title: Status xHandle: type: string title: Xhandle currentWallet: type: string title: Currentwallet setupMessage: type: string title: Setupmessage expiresAt: type: string title: Expiresat walletApprovalUrl: type: string title: Walletapprovalurl type: object required: - enrollmentId - status - xHandle - currentWallet - setupMessage - expiresAt - walletApprovalUrl title: PayMeAuthenticatorEnrollmentResponse PayMeAuthenticatorEnrollmentStatusResponse: properties: enrollmentId: type: string title: Enrollmentid status: type: string title: Status recipientWallet: type: string title: Recipientwallet expiresAt: type: string title: Expiresat type: object required: - enrollmentId - status - recipientWallet - expiresAt title: PayMeAuthenticatorEnrollmentStatusResponse PayMeAuthenticatorSetupResponse: properties: enrollmentId: type: string title: Enrollmentid otpauthUri: type: string title: Otpauthuri manualKey: type: string title: Manualkey currentWallet: type: string title: Currentwallet setupMessage: type: string title: Setupmessage expiresAt: type: string title: Expiresat walletApprovalUrl: type: string title: Walletapprovalurl type: object required: - enrollmentId - otpauthUri - manualKey - currentWallet - setupMessage - expiresAt - walletApprovalUrl title: PayMeAuthenticatorSetupResponse PayMeAuthenticatorWalletSignature: properties: recipientWallet: type: string maxLength: 64 minLength: 32 title: Recipientwallet setupMessage: type: string maxLength: 2000 minLength: 1 title: Setupmessage setupSignature: type: string maxLength: 200 minLength: 32 title: Setupsignature type: object required: - recipientWallet - setupMessage - setupSignature title: PayMeAuthenticatorWalletSignature PayMeCheckoutCreate: properties: tokenMint: type: string maxLength: 64 minLength: 32 title: Tokenmint tokenSymbol: type: string maxLength: 24 minLength: 1 title: Tokensymbol tokenName: type: string maxLength: 80 minLength: 1 title: Tokenname tokenImageUrl: type: string maxLength: 500 title: Tokenimageurl default: '' tokenDecimals: type: integer maximum: 18 minimum: 0 title: Tokendecimals recipientAmount: type: string maxLength: 40 minLength: 1 title: Recipientamount note: type: string maxLength: 240 title: Note default: '' payerWallet: type: string maxLength: 64 minLength: 32 title: Payerwallet createdAt: type: string maxLength: 50 minLength: 10 title: Createdat setupMessage: type: string maxLength: 2000 minLength: 1 title: Setupmessage setupSignature: type: string maxLength: 200 minLength: 32 title: Setupsignature paymentRequestId: type: string maxLength: 24 title: Paymentrequestid default: '' paymentIntentId: type: string maxLength: 24 title: Paymentintentid default: '' type: object required: - tokenMint - tokenSymbol - tokenName - tokenDecimals - recipientAmount - payerWallet - createdAt - setupMessage - setupSignature title: PayMeCheckoutCreate PayMeCheckoutEnvelope: properties: checkout: $ref: '#/components/schemas/PayMeCheckoutResponse' url: type: string title: Url type: object required: - checkout - url title: PayMeCheckoutEnvelope PayMeCheckoutQuoteResponse: properties: recipientAmount: type: string title: Recipientamount requestedRecipientAmount: type: string title: Requestedrecipientamount buyerAmount: type: string title: Buyeramount hiltFeeAmount: type: string title: Hiltfeeamount platformFeeBps: type: integer title: Platformfeebps tokenSymbol: type: string title: Tokensymbol type: object required: - recipientAmount - requestedRecipientAmount - buyerAmount - hiltFeeAmount - platformFeeBps - tokenSymbol title: PayMeCheckoutQuoteResponse PayMeCheckoutResponse: properties: id: type: string title: Id status: type: string title: Status payPost: $ref: '#/components/schemas/PayMeProfileResponse' link: type: object title: Link url: type: string title: Url quote: $ref: '#/components/schemas/PayMeCheckoutQuoteResponse' createdAt: type: string title: Createdat paymentRequestId: type: string title: Paymentrequestid paymentIntentId: type: string title: Paymentintentid type: object required: - id - status - payPost - link - url - quote - createdAt - paymentRequestId - paymentIntentId title: PayMeCheckoutResponse PayMeIdentityResponse: properties: xUserId: type: string title: Xuserid xHandle: type: string title: Xhandle recipientName: type: string title: Recipientname xAvatarUrl: type: string title: Xavatarurl xProfileUrl: type: string title: Xprofileurl type: object required: - xUserId - xHandle - recipientName - xAvatarUrl - xProfileUrl title: PayMeIdentityResponse PayMeOrderAssetResponse: properties: mint: type: string title: Mint symbol: type: string title: Symbol name: type: string title: Name decimals: type: integer title: Decimals type: object required: - mint - symbol - name - decimals title: PayMeOrderAssetResponse PayMeOrderConfirm: properties: payerWallet: type: string maxLength: 64 minLength: 32 title: Payerwallet txSignature: type: string maxLength: 100 minLength: 64 title: Txsignature type: object required: - payerWallet - txSignature title: PayMeOrderConfirm PayMeOrderCreate: properties: payerWallet: type: string maxLength: 64 minLength: 32 title: Payerwallet recipients: items: $ref: '#/components/schemas/PayMeOrderRecipientCreate' type: array maxItems: 5 minItems: 1 title: Recipients note: type: string maxLength: 240 title: Note default: '' source: type: string pattern: ^(web|solana_action)$ title: Source default: web type: object required: - payerWallet - recipients title: PayMeOrderCreate PayMeOrderEnvelope: properties: order: $ref: '#/components/schemas/PayMeOrderResponse' type: object required: - order title: PayMeOrderEnvelope PayMeOrderQuoteResponse: properties: recipientAmount: type: string title: Recipientamount buyerAmount: type: string title: Buyeramount hiltFeeAmount: type: string title: Hiltfeeamount platformFeeBps: type: integer title: Platformfeebps type: object required: - recipientAmount - buyerAmount - hiltFeeAmount - platformFeeBps title: PayMeOrderQuoteResponse PayMeOrderRecipientCreate: properties: xHandle: type: string maxLength: 16 minLength: 1 title: Xhandle recipientAmount: type: string maxLength: 40 minLength: 1 title: Recipientamount type: object required: - xHandle - recipientAmount title: PayMeOrderRecipientCreate PayMeOrderRecipientResponse: properties: receiptId: type: string title: Receiptid xHandle: type: string title: Xhandle recipientName: type: string title: Recipientname recipientWallet: type: string title: Recipientwallet recipientAmount: type: string title: Recipientamount position: type: integer title: Position type: object required: - receiptId - xHandle - recipientName - recipientWallet - recipientAmount - position title: PayMeOrderRecipientResponse PayMeOrderResponse: properties: id: type: string title: Id status: type: string title: Status payerWallet: type: string title: Payerwallet asset: $ref: '#/components/schemas/PayMeOrderAssetResponse' recipients: items: $ref: '#/components/schemas/PayMeOrderRecipientResponse' type: array title: Recipients quote: $ref: '#/components/schemas/PayMeOrderQuoteResponse' feeWallet: type: string title: Feewallet memo: type: string title: Memo note: type: string title: Note source: type: string title: Source txSignature: type: string title: Txsignature solscanUrl: type: string title: Solscanurl createdAt: type: string title: Createdat expiresAt: type: string title: Expiresat completedAt: type: string title: Completedat type: object required: - id - status - payerWallet - asset - recipients - quote - feeWallet - memo - note - source - txSignature - solscanUrl - createdAt - expiresAt - completedAt title: PayMeOrderResponse PayMeProfileCreate: properties: version: type: integer maximum: 1 minimum: 1 title: Version default: 1 recipientWallet: type: string maxLength: 64 minLength: 32 title: Recipientwallet message: type: string maxLength: 240 title: Message default: '' createdAt: type: string maxLength: 50 minLength: 10 title: Createdat setupMessage: type: string maxLength: 2000 minLength: 1 title: Setupmessage setupSignature: type: string maxLength: 200 minLength: 32 title: Setupsignature type: object required: - recipientWallet - createdAt - setupMessage - setupSignature title: PayMeProfileCreate PayMeProfileEnvelope: properties: profile: $ref: '#/components/schemas/PayMeProfileResponse' url: anyOf: - type: string - type: 'null' title: Url type: object required: - profile title: PayMeProfileEnvelope PayMeProfileResponse: properties: slug: type: string title: Slug url: type: string title: Url version: type: integer title: Version recipientName: type: string title: Recipientname recipientWallet: type: string title: Recipientwallet xHandle: type: string title: Xhandle xProfileUrl: type: string title: Xprofileurl xAvatarUrl: type: string title: Xavatarurl identityVerified: type: boolean title: Identityverified message: type: string title: Message walletVerified: type: boolean title: Walletverified createdAt: type: string title: Createdat type: object required: - slug - url - version - recipientName - recipientWallet - xHandle - xProfileUrl - xAvatarUrl - identityVerified - message - walletVerified - createdAt title: PayMeProfileResponse PayMeSecurityStatusResponse: properties: authenticatorEnabled: type: boolean title: Authenticatorenabled recoveryCodesRemaining: type: integer title: Recoverycodesremaining walletChangeAllowed: type: boolean title: Walletchangeallowed currentWallet: type: string title: Currentwallet type: object required: - authenticatorEnabled - recoveryCodesRemaining - walletChangeAllowed - currentWallet title: PayMeSecurityStatusResponse PayMeSessionResponse: properties: identity: $ref: '#/components/schemas/PayMeIdentityResponse' profile: anyOf: - $ref: '#/components/schemas/PayMeProfileResponse' - type: 'null' type: object required: - identity - profile title: PayMeSessionResponse PayMeWalletLinkCreate: properties: message: type: string maxLength: 240 title: Message default: '' securityCode: type: string maxLength: 20 title: Securitycode default: '' type: object title: PayMeWalletLinkCreate PayMeWalletLinkEnvelope: properties: walletLink: anyOf: - $ref: '#/components/schemas/PayMeWalletLinkPublic' - $ref: '#/components/schemas/PayMeWalletLinkStatus' title: Walletlink type: object required: - walletLink title: PayMeWalletLinkEnvelope PayMeWalletLinkPrepare: properties: recipientWallet: type: string maxLength: 64 minLength: 32 title: Recipientwallet type: object required: - recipientWallet title: PayMeWalletLinkPrepare PayMeWalletLinkPublic: properties: walletLinkId: type: string title: Walletlinkid status: type: string title: Status recipientName: type: string title: Recipientname xHandle: type: string title: Xhandle xAvatarUrl: type: string title: Xavatarurl xProfileUrl: type: string title: Xprofileurl message: type: string title: Message expiresAt: type: string title: Expiresat walletLinkUrl: anyOf: - type: string - type: 'null' title: Walletlinkurl type: object required: - walletLinkId - status - recipientName - xHandle - xAvatarUrl - xProfileUrl - message - expiresAt title: PayMeWalletLinkPublic PayMeWalletLinkSignature: properties: recipientWallet: type: string maxLength: 64 minLength: 32 title: Recipientwallet setupMessage: type: string maxLength: 2000 minLength: 1 title: Setupmessage setupSignature: type: string maxLength: 200 minLength: 32 title: Setupsignature type: object required: - recipientWallet - setupMessage - setupSignature title: PayMeWalletLinkSignature PayMeWalletLinkStatus: properties: walletLinkId: type: string title: Walletlinkid status: type: string title: Status recipientWallet: type: string title: Recipientwallet expiresAt: type: string title: Expiresat type: object required: - walletLinkId - status - recipientWallet - expiresAt title: PayMeWalletLinkStatus PayMeWalletPrepareResponse: properties: recipientWallet: type: string title: Recipientwallet setupMessage: type: string title: Setupmessage createdAt: type: string title: Createdat expiresAt: type: string title: Expiresat type: object required: - recipientWallet - setupMessage - createdAt - expiresAt title: PayMeWalletPrepareResponse PayMeWalletSignatureResponse: properties: status: type: string title: Status recipientWallet: type: string title: Recipientwallet type: object required: - status - recipientWallet title: PayMeWalletSignatureResponse PaymentIntentEnvelope: properties: payment: $ref: '#/components/schemas/PaymentIntentResponse' type: object required: - payment title: PaymentIntentEnvelope PaymentIntentFeePreviewResponse: properties: hiltFeeAmount: type: string title: Hiltfeeamount buyerTotal: type: string title: Buyertotal platformFeePercent: type: string title: Platformfeepercent type: object required: - hiltFeeAmount - buyerTotal - platformFeePercent title: PaymentIntentFeePreviewResponse PaymentIntentResponse: properties: id: type: string title: Id direction: type: string title: Direction status: type: string title: Status recipient: $ref: '#/components/schemas/PaymentRequestRecipientResponse' asset: $ref: '#/components/schemas/PaymentRequestAssetResponse' recipientAmount: type: string title: Recipientamount feePreview: $ref: '#/components/schemas/PaymentIntentFeePreviewResponse' note: type: string title: Note approvalUrl: type: string title: Approvalurl txSignature: type: string title: Txsignature solscanUrl: type: string title: Solscanurl createdAt: type: string title: Createdat expiresAt: type: string title: Expiresat authorizedAt: type: string title: Authorizedat confirmedAt: type: string title: Confirmedat walletApprovalRequired: type: boolean title: Walletapprovalrequired type: object required: - id - direction - status - recipient - asset - recipientAmount - feePreview - note - approvalUrl - txSignature - solscanUrl - createdAt - expiresAt - authorizedAt - confirmedAt - walletApprovalRequired title: PaymentIntentResponse PaymentListResponse: items: $ref: '#/components/schemas/PaymentResponse' type: array title: PaymentListResponse PaymentRequestAssetResponse: properties: mint: type: string title: Mint symbol: type: string title: Symbol name: type: string title: Name decimals: type: integer title: Decimals type: object required: - mint - symbol - name - decimals title: PaymentRequestAssetResponse PaymentRequestCreate: properties: amount: type: string maxLength: 40 minLength: 1 title: Amount asset: type: string maxLength: 12 title: Asset default: USDC from_x_handle: type: string maxLength: 16 title: From X Handle default: '' note: type: string maxLength: 240 title: Note default: '' expires_in_hours: type: integer maximum: 168 minimum: 1 title: Expires In Hours default: 72 type: object required: - amount title: PaymentRequestCreate PaymentRequestEnvelope: properties: paymentRequest: $ref: '#/components/schemas/PaymentRequestResponse' type: object required: - paymentRequest title: PaymentRequestEnvelope PaymentRequestRecipientResponse: properties: name: type: string title: Name xHandle: type: string title: Xhandle xProfileUrl: type: string title: Xprofileurl recipientWallet: type: string title: Recipientwallet identityVerified: type: boolean title: Identityverified walletVerified: type: boolean title: Walletverified type: object required: - name - xHandle - xProfileUrl - recipientWallet - identityVerified - walletVerified title: PaymentRequestRecipientResponse PaymentRequestResponse: properties: id: type: string title: Id status: type: string title: Status recipient: $ref: '#/components/schemas/PaymentRequestRecipientResponse' requestedFromXHandle: type: string title: Requestedfromxhandle asset: $ref: '#/components/schemas/PaymentRequestAssetResponse' recipientAmount: type: string title: Recipientamount note: type: string title: Note approvalUrl: type: string title: Approvalurl payerWallet: type: string title: Payerwallet txSignature: type: string title: Txsignature createdAt: type: string title: Createdat expiresAt: type: string title: Expiresat paidAt: type: string title: Paidat type: object required: - id - status - recipient - requestedFromXHandle - asset - recipientAmount - note - approvalUrl - payerWallet - txSignature - createdAt - expiresAt - paidAt title: PaymentRequestResponse PaymentResponse: properties: id: type: string title: Id product_id: type: string title: Product Id payer_wallet: anyOf: - type: string - type: 'null' title: Payer Wallet amount_minor_units: type: integer title: Amount Minor Units merchant_amount_lamports: anyOf: - type: integer - type: 'null' title: Merchant Amount Lamports fee_lamports: anyOf: - type: integer - type: 'null' title: Fee Lamports token_mint: anyOf: - type: string - type: 'null' title: Token Mint status: type: string title: Status tx_signature: anyOf: - type: string - type: 'null' title: Tx Signature membership_id: anyOf: - type: string - type: 'null' title: Membership Id customer_reference_type: anyOf: - type: string - type: 'null' title: Customer Reference Type customer_reference_value: anyOf: - type: string - type: 'null' title: Customer Reference Value customer_reference_display: anyOf: - type: string - type: 'null' title: Customer Reference Display delivery_status: anyOf: - type: string - type: 'null' title: Delivery Status delivery_error: anyOf: - type: string - type: 'null' title: Delivery Error created_at: anyOf: - type: string - type: 'null' title: Created At confirmed_at: anyOf: - type: string - type: 'null' title: Confirmed At failed_at: anyOf: - type: string - type: 'null' title: Failed At delivery_sent_at: anyOf: - type: string - type: 'null' title: Delivery Sent At deep_link_expires_at: anyOf: - type: string - type: 'null' title: Deep Link Expires At delivery_attempted_at: anyOf: - type: string - type: 'null' title: Delivery Attempted At additionalProperties: true type: object required: - id - product_id - payer_wallet - amount_minor_units - token_mint - status - created_at title: PaymentResponse PhantomConnectCallbackRequest: properties: payment_id: type: string title: Payment Id phantom_encryption_public_key: type: string title: Phantom Encryption Public Key nonce: type: string title: Nonce data: type: string title: Data type: object required: - payment_id - phantom_encryption_public_key - nonce - data title: PhantomConnectCallbackRequest PhantomConnectCallbackResponse: properties: payment_id: type: string title: Payment Id wallet_address: type: string title: Wallet Address wallet_source: type: string title: Wallet Source session_stored: type: boolean title: Session Stored type: object required: - payment_id - wallet_address - wallet_source - session_stored title: PhantomConnectCallbackResponse PhantomDeeplinkResponse: properties: payment_id: type: string title: Payment Id deeplink_url: type: string title: Deeplink Url type: object required: - payment_id - deeplink_url title: PhantomDeeplinkResponse PhantomMessageCallbackRequest: properties: payment_id: type: string title: Payment Id identity_session_id: type: string title: Identity Session Id nonce: type: string title: Nonce data: type: string title: Data type: object required: - payment_id - identity_session_id - nonce - data title: PhantomMessageCallbackRequest PhantomMessageCallbackResponse: properties: payment_id: type: string title: Payment Id identity_session_id: type: string title: Identity Session Id wallet_address: type: string title: Wallet Address verified_at: type: string title: Verified At type: object required: - payment_id - identity_session_id - wallet_address - verified_at title: PhantomMessageCallbackResponse PhantomMessageUrlRequest: properties: payment_id: type: string title: Payment Id identity_session_id: type: string title: Identity Session Id handoff_token: anyOf: - type: string - type: 'null' title: Handoff Token type: object required: - payment_id - identity_session_id title: PhantomMessageUrlRequest PhantomRenewalMessageCallbackRequest: properties: payment_id: type: string title: Payment Id automatic_renew_setup_key: type: string title: Automatic Renew Setup Key nonce: type: string title: Nonce data: type: string title: Data type: object required: - payment_id - automatic_renew_setup_key - nonce - data title: PhantomRenewalMessageCallbackRequest PhantomRenewalMessageCallbackResponse: properties: payment_id: type: string title: Payment Id automatic_renew_setup_key: type: string title: Automatic Renew Setup Key wallet_address: type: string title: Wallet Address signed_message_b64: type: string title: Signed Message B64 type: object required: - payment_id - automatic_renew_setup_key - wallet_address - signed_message_b64 title: PhantomRenewalMessageCallbackResponse PhantomRenewalMessageUrlRequest: properties: payment_id: type: string title: Payment Id automatic_renew_setup_key: type: string title: Automatic Renew Setup Key handoff_token: anyOf: - type: string - type: 'null' title: Handoff Token type: object required: - payment_id - automatic_renew_setup_key title: PhantomRenewalMessageUrlRequest PhantomTransactionCallbackRequest: properties: payment_id: type: string title: Payment Id nonce: type: string title: Nonce data: type: string title: Data type: object required: - payment_id - nonce - data title: PhantomTransactionCallbackRequest PhantomTransactionCallbackResponse: properties: payment_id: type: string title: Payment Id wallet_address: type: string title: Wallet Address serialized_transaction_b64: type: string title: Serialized Transaction B64 type: object required: - payment_id - wallet_address - serialized_transaction_b64 title: PhantomTransactionCallbackResponse PhantomTransactionUrlRequest: properties: payment_id: type: string title: Payment Id serialized_transaction_b58: type: string title: Serialized Transaction B58 handoff_token: anyOf: - type: string - type: 'null' title: Handoff Token type: object required: - payment_id - serialized_transaction_b58 title: PhantomTransactionUrlRequest ProductAnalyticsResponse: properties: product_id: type: string title: Product Id merchant_id: type: string title: Merchant Id merchant_name: type: string title: Merchant Name merchant_email: anyOf: - type: string - type: 'null' title: Merchant Email product_title: type: string title: Product Title product_slug: type: string title: Product Slug product_type: type: string title: Product Type status: type: string title: Status token_mint: type: string title: Token Mint asset_symbol: type: string title: Asset Symbol asset_decimals: type: integer title: Asset Decimals checkout_opens: type: integer title: Checkout Opens checkout_connects: type: integer title: Checkout Connects checkout_confirmed: type: integer title: Checkout Confirmed checkout_failed: type: integer title: Checkout Failed pending_checkouts: type: integer title: Pending Checkouts confirmed_payment_count: type: integer title: Confirmed Payment Count gross_minor_units: type: integer title: Gross Minor Units net_minor_units: type: integer title: Net Minor Units fee_minor_units: type: integer title: Fee Minor Units tracked_memberships: type: integer title: Tracked Memberships active_memberships: type: integer title: Active Memberships expiring_soon_count: type: integer title: Expiring Soon Count grace_count: type: integer title: Grace Count delivery_failed_count: type: integer title: Delivery Failed Count renewed_30d_count: type: integer title: Renewed 30D Count expired_30d_count: type: integer title: Expired 30D Count reminded_30d_count: type: integer title: Reminded 30D Count open_support_count: type: integer title: Open Support Count support_30d_count: type: integer title: Support 30D Count latest_payment_at: anyOf: - type: string - type: 'null' title: Latest Payment At connect_rate_pct: type: number title: Connect Rate Pct confirm_rate_pct: type: number title: Confirm Rate Pct completion_rate_pct: type: number title: Completion Rate Pct failed_delivery_rate_pct: type: number title: Failed Delivery Rate Pct renewal_rate_pct: type: number title: Renewal Rate Pct confirmed_count: type: integer title: Confirmed Count failed_count: type: integer title: Failed Count pending_count: type: integer title: Pending Count total_volume_lamports: type: integer title: Total Volume Lamports total_fees_lamports: type: integer title: Total Fees Lamports last_payment_at: anyOf: - type: string - type: 'null' title: Last Payment At window_days: type: integer title: Window Days funnel_daily: items: type: object type: array title: Funnel Daily generated_at: type: string title: Generated At additionalProperties: true type: object required: - product_id - merchant_id - merchant_name - merchant_email - product_title - product_slug - product_type - status - token_mint - asset_symbol - asset_decimals - checkout_opens - checkout_connects - checkout_confirmed - checkout_failed - pending_checkouts - confirmed_payment_count - gross_minor_units - net_minor_units - fee_minor_units - tracked_memberships - active_memberships - expiring_soon_count - grace_count - delivery_failed_count - renewed_30d_count - expired_30d_count - reminded_30d_count - open_support_count - support_30d_count - latest_payment_at - connect_rate_pct - confirm_rate_pct - completion_rate_pct - failed_delivery_rate_pct - renewal_rate_pct - confirmed_count - failed_count - pending_count - total_volume_lamports - total_fees_lamports - last_payment_at - window_days - funnel_daily - generated_at title: ProductAnalyticsResponse ProductListResponse: items: $ref: '#/components/schemas/ProductResponse' type: array title: ProductListResponse ProductResponse: properties: id: type: string title: Id owner_id: anyOf: - type: string - type: 'null' title: Owner Id product_type: type: string title: Product Type status: type: string title: Status title: type: string title: Title description: anyOf: - type: string - type: 'null' title: Description image_url: anyOf: - type: string - type: 'null' title: Image Url amount_minor_units: anyOf: - type: integer - type: 'null' title: Amount Minor Units token_mint: anyOf: - type: string - type: 'null' title: Token Mint merchant_wallet: type: string title: Merchant Wallet delivery_type: anyOf: - type: string - type: 'null' title: Delivery Type delivery_value: anyOf: - type: string - type: 'null' title: Delivery Value tip_presets_lamports: anyOf: - items: type: integer type: array - type: 'null' title: Tip Presets Lamports atomic_fee_pct: anyOf: - type: number - type: 'null' title: Atomic Fee Pct atomic_fee_flat_usd_cents: anyOf: - type: integer - type: 'null' title: Atomic Fee Flat Usd Cents atomic_fee_cap_usd: anyOf: - type: number - type: 'null' title: Atomic Fee Cap Usd max_payments: anyOf: - type: integer - type: 'null' title: Max Payments slug: type: string title: Slug payment_count: anyOf: - type: integer - type: 'null' title: Payment Count total_volume_lamports: anyOf: - type: integer - type: 'null' title: Total Volume Lamports membership_config: anyOf: - type: object - type: 'null' title: Membership Config membership_enabled: anyOf: - type: boolean - type: 'null' title: Membership Enabled membership_platform: anyOf: - type: string - type: 'null' title: Membership Platform membership_identity_type: anyOf: - type: string - type: 'null' title: Membership Identity Type membership_identity_label: anyOf: - type: string - type: 'null' title: Membership Identity Label membership_identity_required: anyOf: - type: boolean - type: 'null' title: Membership Identity Required membership_renewal_mode: anyOf: - type: string - type: 'null' title: Membership Renewal Mode membership_billing_interval_days: anyOf: - type: integer - type: 'null' title: Membership Billing Interval Days checkout_config: anyOf: - type: object - type: 'null' title: Checkout Config created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - product_type - status - title - description - image_url - amount_minor_units - token_mint - merchant_wallet - slug - created_at title: ProductResponse PublicPaymentStatusResponse: properties: id: type: string title: Id status: type: string title: Status amount_minor_units: type: integer title: Amount Minor Units token_mint: anyOf: - type: string - type: 'null' title: Token Mint tx_signature: anyOf: - type: string - type: 'null' title: Tx Signature confirmed_at: anyOf: - type: string - type: 'null' title: Confirmed At failed_at: anyOf: - type: string - type: 'null' title: Failed At failure_reason: anyOf: - type: string - type: 'null' title: Failure Reason delivery_sent_at: anyOf: - type: string - type: 'null' title: Delivery Sent At deep_link_expires_at: anyOf: - type: string - type: 'null' title: Deep Link Expires At delivery_status: anyOf: - type: string - type: 'null' title: Delivery Status delivery_error: anyOf: - type: string - type: 'null' title: Delivery Error delivery_attempted_at: anyOf: - type: string - type: 'null' title: Delivery Attempted At membership_id: anyOf: - type: string - type: 'null' title: Membership Id additionalProperties: true type: object required: - id - status - amount_minor_units - token_mint - tx_signature - confirmed_at - failed_at - failure_reason - delivery_sent_at - deep_link_expires_at - delivery_status - delivery_error - delivery_attempted_at - membership_id title: PublicPaymentStatusResponse PublicReceiptResponse: properties: receipt_id: type: string title: Receipt Id receipt_json: type: object title: Receipt Json receipt_hash: type: string title: Receipt Hash ed25519_sig: type: string title: Ed25519 Sig schema_version: type: string title: Schema Version created_at: anyOf: - type: string - type: 'null' title: Created At generated_at: anyOf: - type: string - type: 'null' title: Generated At verify_url: type: string title: Verify Url verify_api_url: anyOf: - type: string - type: 'null' title: Verify Api Url pdf_url: anyOf: - type: string - type: 'null' title: Pdf Url tx_sig: anyOf: - type: string - type: 'null' title: Tx Sig payment_id: anyOf: - type: string - type: 'null' title: Payment Id product_id: anyOf: - type: string - type: 'null' title: Product Id product_title: anyOf: - type: string - type: 'null' title: Product Title product_slug: anyOf: - type: string - type: 'null' title: Product Slug payer_wallet: anyOf: - type: string - type: 'null' title: Payer Wallet merchant_wallet: anyOf: - type: string - type: 'null' title: Merchant Wallet amount_minor_units: anyOf: - type: integer - type: 'null' title: Amount Minor Units amount_display: anyOf: - type: string - type: 'null' title: Amount Display token_mint: anyOf: - type: string - type: 'null' title: Token Mint invoice_metadata: anyOf: - $ref: '#/components/schemas/ReceiptInvoiceMetadata' - type: 'null' owner_display_name: anyOf: - type: string - type: 'null' title: Owner Display Name owner_email: anyOf: - type: string - type: 'null' title: Owner Email credits_burned: anyOf: - type: integer - type: 'null' title: Credits Burned idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay verification: $ref: '#/components/schemas/ReceiptVerification' additionalProperties: true type: object required: - receipt_id - receipt_json - receipt_hash - ed25519_sig - schema_version - verify_url - verification title: PublicReceiptResponse ReceiptInvoiceMetadata: properties: invoice_number: anyOf: - type: string - type: 'null' title: Invoice Number customer_name: anyOf: - type: string - type: 'null' title: Customer Name customer_email: anyOf: - type: string - type: 'null' title: Customer Email billing_reference: anyOf: - type: string - type: 'null' title: Billing Reference notes: anyOf: - type: string - type: 'null' title: Notes metadata_json: type: object title: Metadata Json additionalProperties: true type: object required: - invoice_number - customer_name - customer_email - billing_reference - notes - metadata_json title: ReceiptInvoiceMetadata ReceiptInvoiceMetadataRequest: properties: invoice_number: anyOf: - type: string maxLength: 120 - type: 'null' title: Invoice Number customer_name: anyOf: - type: string maxLength: 180 - type: 'null' title: Customer Name customer_email: anyOf: - type: string maxLength: 180 - type: 'null' title: Customer Email billing_reference: anyOf: - type: string maxLength: 180 - type: 'null' title: Billing Reference notes: anyOf: - type: string maxLength: 1200 - type: 'null' title: Notes type: object title: ReceiptInvoiceMetadataRequest ReceiptListItem: properties: receipt_id: type: string title: Receipt Id tx_sig: type: string title: Tx Sig receipt_hash: type: string title: Receipt Hash schema_version: type: string title: Schema Version created_at: type: string title: Created At verify_url: type: string title: Verify Url product_id: anyOf: - type: string - type: 'null' title: Product Id product_title: anyOf: - type: string - type: 'null' title: Product Title payer_wallet: anyOf: - type: string - type: 'null' title: Payer Wallet amount_minor_units: anyOf: - type: integer - type: 'null' title: Amount Minor Units amount_display: type: string title: Amount Display invoice_number: anyOf: - type: string - type: 'null' title: Invoice Number additionalProperties: true type: object required: - receipt_id - tx_sig - receipt_hash - schema_version - created_at - verify_url - product_id - product_title - payer_wallet - amount_minor_units - amount_display - invoice_number title: ReceiptListItem ReceiptListResponse: properties: total: type: integer title: Total page: type: integer title: Page per_page: type: integer title: Per Page receipts: items: $ref: '#/components/schemas/ReceiptListItem' type: array title: Receipts additionalProperties: true type: object required: - total - page - per_page - receipts title: ReceiptListResponse ReceiptProofEmailResponse: properties: sent: type: boolean title: Sent email: type: string title: Email verify_url: type: string title: Verify Url pdf_url: type: string title: Pdf Url additionalProperties: true type: object required: - sent - email - verify_url - pdf_url title: ReceiptProofEmailResponse ReceiptRequest: properties: tx_sig: type: string title: Tx Sig description: Solana transaction signature wallet: anyOf: - type: string - type: 'null' title: Wallet description: Signer wallet address counterparty_wallet: anyOf: - type: string - type: 'null' title: Counterparty Wallet description: Counterparty wallet address token_mint: anyOf: - type: string - type: 'null' title: Token Mint description: Token mint address amount_raw: anyOf: - type: integer - type: 'null' title: Amount Raw description: Raw token amount (lamports or base units) memo: anyOf: - type: string - type: 'null' title: Memo description: Human-readable memo type: object required: - tx_sig title: ReceiptRequest ReceiptResponse: properties: receipt_id: type: string title: Receipt Id receipt_json: type: object title: Receipt Json receipt_hash: type: string title: Receipt Hash ed25519_sig: type: string title: Ed25519 Sig schema_version: type: string title: Schema Version created_at: anyOf: - type: string - type: 'null' title: Created At generated_at: anyOf: - type: string - type: 'null' title: Generated At verify_url: type: string title: Verify Url verify_api_url: anyOf: - type: string - type: 'null' title: Verify Api Url pdf_url: anyOf: - type: string - type: 'null' title: Pdf Url tx_sig: anyOf: - type: string - type: 'null' title: Tx Sig payment_id: anyOf: - type: string - type: 'null' title: Payment Id product_id: anyOf: - type: string - type: 'null' title: Product Id product_title: anyOf: - type: string - type: 'null' title: Product Title product_slug: anyOf: - type: string - type: 'null' title: Product Slug payer_wallet: anyOf: - type: string - type: 'null' title: Payer Wallet merchant_wallet: anyOf: - type: string - type: 'null' title: Merchant Wallet amount_minor_units: anyOf: - type: integer - type: 'null' title: Amount Minor Units amount_display: anyOf: - type: string - type: 'null' title: Amount Display token_mint: anyOf: - type: string - type: 'null' title: Token Mint invoice_metadata: anyOf: - $ref: '#/components/schemas/ReceiptInvoiceMetadata' - type: 'null' owner_display_name: anyOf: - type: string - type: 'null' title: Owner Display Name owner_email: anyOf: - type: string - type: 'null' title: Owner Email credits_burned: anyOf: - type: integer - type: 'null' title: Credits Burned idempotent_replay: anyOf: - type: boolean - type: 'null' title: Idempotent Replay additionalProperties: true type: object required: - receipt_id - receipt_json - receipt_hash - ed25519_sig - schema_version - verify_url title: ReceiptResponse ReceiptSendProofRequest: properties: email: anyOf: - type: string maxLength: 180 - type: 'null' title: Email note: anyOf: - type: string maxLength: 500 - type: 'null' title: Note type: object title: ReceiptSendProofRequest ReceiptUpdateResponse: properties: receipt: $ref: '#/components/schemas/ReceiptResponse' additionalProperties: true type: object required: - receipt title: ReceiptUpdateResponse ReceiptVerification: properties: valid: type: boolean title: Valid hash_valid: type: boolean title: Hash Valid signature_valid: type: boolean title: Signature Valid signature_required: type: boolean title: Signature Required computed_hash: type: string title: Computed Hash stored_hash: type: string title: Stored Hash on_chain_anchor: anyOf: - type: string - type: 'null' title: On Chain Anchor checked_at: type: string title: Checked At additionalProperties: true type: object required: - valid - hash_valid - signature_valid - signature_required - computed_hash - stored_hash - on_chain_anchor - checked_at title: ReceiptVerification RefreshRequest: properties: token: type: string title: Token type: object required: - token title: RefreshRequest RegisterRequest: properties: email: type: string format: email title: Email password: type: string title: Password display_name: anyOf: - type: string - type: 'null' title: Display Name referral_code: anyOf: - type: string - type: 'null' title: Referral Code type: object required: - email - password title: RegisterRequest SandboxScenario: properties: id: type: string title: Id title: type: string title: Title summary: type: string title: Summary events: items: type: string type: array title: Events additionalProperties: true type: object required: - id - title - summary - events title: SandboxScenario SandboxScenariosResponse: properties: scenarios: items: $ref: '#/components/schemas/SandboxScenario' type: array title: Scenarios count: type: integer title: Count additionalProperties: true type: object required: - scenarios - count title: SandboxScenariosResponse SandboxSessionCreateRequest: properties: scenario: type: string maxLength: 80 minLength: 2 title: Scenario product_id: anyOf: - type: string - type: 'null' title: Product Id amount_minor_units: anyOf: - type: integer minimum: 1 - type: 'null' title: Amount Minor Units payer_wallet: anyOf: - type: string maxLength: 160 - type: 'null' title: Payer Wallet identity_display: anyOf: - type: string maxLength: 160 - type: 'null' title: Identity Display type: object required: - scenario title: SandboxSessionCreateRequest StripeCheckoutRequest: properties: plan: type: string enum: - starter - growth - scale title: Plan interval: type: string enum: - monthly - yearly title: Interval default: monthly success_url: type: string maxLength: 2048 minLength: 8 title: Success Url cancel_url: type: string maxLength: 2048 minLength: 8 title: Cancel Url type: object required: - plan - success_url - cancel_url title: StripeCheckoutRequest StripeCheckoutResponse: properties: session_id: type: string title: Session Id checkout_url: type: string title: Checkout Url type: object required: - session_id - checkout_url title: StripeCheckoutResponse StripeInvoiceHistoryResponse: properties: invoice_id: anyOf: - type: string - type: 'null' title: Invoice Id invoice_number: anyOf: - type: string - type: 'null' title: Invoice Number status: type: string title: Status billing_reason: anyOf: - type: string - type: 'null' title: Billing Reason currency: type: string title: Currency amount_due_minor_units: type: integer title: Amount Due Minor Units amount_paid_minor_units: type: integer title: Amount Paid Minor Units created_at: anyOf: - type: string - type: 'null' title: Created At hosted_invoice_url: anyOf: - type: string - type: 'null' title: Hosted Invoice Url invoice_pdf: anyOf: - type: string - type: 'null' title: Invoice Pdf description: anyOf: - type: string - type: 'null' title: Description type: object required: - status - currency - amount_due_minor_units - amount_paid_minor_units title: StripeInvoiceHistoryResponse StripePortalRequest: properties: return_url: type: string maxLength: 2048 minLength: 8 title: Return Url type: object required: - return_url title: StripePortalRequest StripePortalResponse: properties: portal_url: type: string title: Portal Url type: object required: - portal_url title: StripePortalResponse StripeRefreshResponse: properties: refreshed: type: boolean title: Refreshed tier: type: string title: Tier billing_status: type: string title: Billing Status stripe_subscription_id: anyOf: - type: string - type: 'null' title: Stripe Subscription Id stripe_price_id: anyOf: - type: string - type: 'null' title: Stripe Price Id current_period_end: anyOf: - type: string - type: 'null' title: Current Period End type: object required: - refreshed - tier - billing_status title: StripeRefreshResponse StripeWebhookResponse: properties: received: type: boolean title: Received ignored: anyOf: - type: boolean - type: 'null' title: Ignored reason: anyOf: - type: string - type: 'null' title: Reason duplicate: anyOf: - type: boolean - type: 'null' title: Duplicate additionalProperties: true type: object required: - received title: StripeWebhookResponse SupportMessage: properties: id: type: string title: Id ticket_id: anyOf: - type: string - type: 'null' title: Ticket Id author_type: anyOf: - type: string - type: 'null' title: Author Type author_id: anyOf: - type: string - type: 'null' title: Author Id body: type: string title: Body created_at: anyOf: - type: string - type: 'null' title: Created At additionalProperties: true type: object required: - id - body title: SupportMessage SupportMessageCreateResponse: properties: ticket_id: type: string title: Ticket Id message: type: string title: Message additionalProperties: true type: object required: - ticket_id - message title: SupportMessageCreateResponse SupportTicket: properties: id: anyOf: - type: string - type: 'null' title: Id ticket_id: type: string title: Ticket Id user_id: anyOf: - type: string - type: 'null' title: User Id subject: type: string title: Subject category: type: string title: Category priority: anyOf: - type: string - type: 'null' title: Priority status: type: string title: Status context: type: object title: Context created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At resolved_at: anyOf: - type: string - type: 'null' title: Resolved At additionalProperties: true type: object required: - ticket_id - subject - category - status title: SupportTicket SupportTicketCreateResponse: properties: ticket_id: type: string title: Ticket Id status: type: string title: Status subject: type: string title: Subject category: type: string title: Category additionalProperties: true type: object required: - ticket_id - status - subject - category title: SupportTicketCreateResponse SupportTicketListResponse: properties: total: type: integer title: Total page: type: integer title: Page tickets: items: $ref: '#/components/schemas/SupportTicket' type: array title: Tickets additionalProperties: true type: object required: - total - page - tickets title: SupportTicketListResponse SupportTicketThreadResponse: properties: id: anyOf: - type: string - type: 'null' title: Id ticket_id: type: string title: Ticket Id user_id: anyOf: - type: string - type: 'null' title: User Id subject: type: string title: Subject category: type: string title: Category priority: anyOf: - type: string - type: 'null' title: Priority status: type: string title: Status context: type: object title: Context created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At resolved_at: anyOf: - type: string - type: 'null' title: Resolved At messages: items: $ref: '#/components/schemas/SupportMessage' type: array title: Messages additionalProperties: true type: object required: - ticket_id - subject - category - status - messages title: SupportTicketThreadResponse TestingSandboxCreateResponse: properties: session: $ref: '#/components/schemas/TestingSandboxSession' scenario: $ref: '#/components/schemas/SandboxScenario' emitted_events: items: $ref: '#/components/schemas/WebhookEvent' type: array title: Emitted Events delivery_results: items: type: object type: array title: Delivery Results supported_events: items: type: string type: array title: Supported Events additionalProperties: true type: object required: - session - scenario - emitted_events - delivery_results - supported_events title: TestingSandboxCreateResponse TestingSandboxDetailResponse: properties: session: $ref: '#/components/schemas/TestingSandboxSession' supported_scenarios: items: $ref: '#/components/schemas/SandboxScenario' type: array title: Supported Scenarios additionalProperties: true type: object required: - session - supported_scenarios title: TestingSandboxDetailResponse TestingSandboxListResponse: properties: sessions: items: $ref: '#/components/schemas/TestingSandboxSession' type: array title: Sessions count: type: integer title: Count generated_at: type: string title: Generated At additionalProperties: true type: object required: - sessions - count - generated_at title: TestingSandboxListResponse TestingSandboxSession: properties: id: type: string title: Id owner_id: type: string title: Owner Id product_id: anyOf: - type: string - type: 'null' title: Product Id scenario: type: string title: Scenario status: type: string title: Status fake_payment_id: anyOf: - type: string - type: 'null' title: Fake Payment Id fake_membership_id: anyOf: - type: string - type: 'null' title: Fake Membership Id fake_receipt_id: anyOf: - type: string - type: 'null' title: Fake Receipt Id fake_support_ticket_id: anyOf: - type: string - type: 'null' title: Fake Support Ticket Id event_count: type: integer title: Event Count delivery_count: type: integer title: Delivery Count request: type: object title: Request timeline: anyOf: - items: type: object type: array - type: 'null' title: Timeline created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - owner_id - product_id - scenario - status - fake_payment_id - fake_membership_id - fake_receipt_id - fake_support_ticket_id - event_count - delivery_count - request - created_at - updated_at title: TestingSandboxSession UpdateProductRequest: properties: title: anyOf: - type: string maxLength: 120 minLength: 1 - type: 'null' title: Title description: anyOf: - type: string - type: 'null' title: Description image_url: anyOf: - type: string - type: 'null' title: Image Url amount_minor_units: anyOf: - type: integer exclusiveMinimum: 0 - type: 'null' title: Amount Minor Units merchant_wallet: anyOf: - type: string - type: 'null' title: Merchant Wallet status: anyOf: - type: string - type: 'null' title: Status delivery_type: anyOf: - type: string - type: 'null' title: Delivery Type delivery_value: anyOf: - type: string - type: 'null' title: Delivery Value tip_presets_lamports: anyOf: - items: type: integer type: array - type: 'null' title: Tip Presets Lamports max_payments: anyOf: - type: integer - type: 'null' title: Max Payments membership_config: anyOf: - $ref: '#/components/schemas/MembershipConfigRequest' - type: 'null' type: object title: UpdateProductRequest UpdatedFieldsResponse: properties: detail: type: string title: Detail updated_fields: items: type: string type: array title: Updated Fields additionalProperties: true type: object required: - detail - updated_fields title: UpdatedFieldsResponse ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError VerifyReceiptResponse: properties: valid: type: boolean title: Valid hash_valid: type: boolean title: Hash Valid signature_valid: type: boolean title: Signature Valid signature_required: type: boolean title: Signature Required computed_hash: type: string title: Computed Hash stored_hash: type: string title: Stored Hash on_chain_anchor: anyOf: - type: string - type: 'null' title: On Chain Anchor checked_at: type: string title: Checked At receipt_id: type: string title: Receipt Id generated_at: type: string title: Generated At additionalProperties: true type: object required: - valid - hash_valid - signature_valid - signature_required - computed_hash - stored_hash - on_chain_anchor - checked_at - receipt_id - generated_at title: VerifyReceiptResponse WalletAuthRequest: properties: wallet_address: type: string title: Wallet Address signed_message: type: string title: Signed Message message_nonce: type: string title: Message Nonce type: object required: - wallet_address - signed_message - message_nonce title: WalletAuthRequest WebhookDeliveriesResponse: properties: total: type: integer title: Total page: type: integer title: Page deliveries: items: $ref: '#/components/schemas/WebhookDelivery' type: array title: Deliveries additionalProperties: true type: object required: - total - page - deliveries title: WebhookDeliveriesResponse WebhookDelivery: properties: id: type: integer title: Id event_id: type: string title: Event Id endpoint_id: type: string title: Endpoint Id owner_id: type: string title: Owner Id status: type: string title: Status attempt_count: type: integer title: Attempt Count last_attempt_at: anyOf: - type: string - type: 'null' title: Last Attempt At next_attempt_at: anyOf: - type: string - type: 'null' title: Next Attempt At delivered_at: anyOf: - type: string - type: 'null' title: Delivered At response_status: anyOf: - type: integer - type: 'null' title: Response Status response_body: anyOf: - type: string - type: 'null' title: Response Body last_error: anyOf: - type: string - type: 'null' title: Last Error created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At event_type: anyOf: - type: string - type: 'null' title: Event Type endpoint_label: anyOf: - type: string - type: 'null' title: Endpoint Label url: anyOf: - type: string - type: 'null' title: Url product_id: anyOf: - type: string - type: 'null' title: Product Id payment_id: anyOf: - type: string - type: 'null' title: Payment Id membership_id: anyOf: - type: string - type: 'null' title: Membership Id receipt_id: anyOf: - type: string - type: 'null' title: Receipt Id support_ticket_id: anyOf: - type: string - type: 'null' title: Support Ticket Id additionalProperties: true type: object required: - id - event_id - endpoint_id - owner_id - status - attempt_count - last_attempt_at - next_attempt_at - delivered_at - response_status - response_body - last_error - created_at - updated_at title: WebhookDelivery WebhookDeliveryResponse: properties: delivery: $ref: '#/components/schemas/WebhookDelivery' additionalProperties: true type: object required: - delivery title: WebhookDeliveryResponse WebhookEndpoint: properties: id: type: string title: Id owner_id: type: string title: Owner Id label: type: string title: Label url: type: string title: Url status: type: string title: Status signing_secret_preview: type: string title: Signing Secret Preview subscribed_events: items: type: string type: array title: Subscribed Events product_ids: items: type: string type: array title: Product Ids consecutive_failures: type: integer title: Consecutive Failures last_success_at: anyOf: - type: string - type: 'null' title: Last Success At last_failure_at: anyOf: - type: string - type: 'null' title: Last Failure At last_error: anyOf: - type: string - type: 'null' title: Last Error archived_at: anyOf: - type: string - type: 'null' title: Archived At created_at: anyOf: - type: string - type: 'null' title: Created At updated_at: anyOf: - type: string - type: 'null' title: Updated At additionalProperties: true type: object required: - id - owner_id - label - url - status - signing_secret_preview - subscribed_events - product_ids - consecutive_failures - last_success_at - last_failure_at - last_error - archived_at - created_at - updated_at title: WebhookEndpoint WebhookEndpointCreateRequest: properties: label: type: string maxLength: 120 minLength: 2 title: Label url: type: string title: Url subscribed_events: items: type: string type: array title: Subscribed Events product_ids: items: type: string type: array title: Product Ids type: object required: - label - url title: WebhookEndpointCreateRequest WebhookEndpointCreateResponse: properties: endpoint: $ref: '#/components/schemas/WebhookEndpoint' signing_secret: type: string title: Signing Secret supported_events: anyOf: - items: type: string type: array - type: 'null' title: Supported Events additionalProperties: true type: object required: - endpoint - signing_secret title: WebhookEndpointCreateResponse WebhookEndpointListResponse: properties: endpoints: items: $ref: '#/components/schemas/WebhookEndpoint' type: array title: Endpoints additionalProperties: true type: object required: - endpoints title: WebhookEndpointListResponse WebhookEndpointResponse: properties: endpoint: $ref: '#/components/schemas/WebhookEndpoint' signing_secret: anyOf: - type: string - type: 'null' title: Signing Secret additionalProperties: true type: object required: - endpoint title: WebhookEndpointResponse WebhookEndpointUpdateRequest: properties: label: anyOf: - type: string maxLength: 120 minLength: 2 - type: 'null' title: Label url: anyOf: - type: string - type: 'null' title: Url status: anyOf: - type: string - type: 'null' title: Status subscribed_events: anyOf: - items: type: string type: array - type: 'null' title: Subscribed Events product_ids: anyOf: - items: type: string type: array - type: 'null' title: Product Ids rotate_signing_secret: type: boolean title: Rotate Signing Secret default: false type: object title: WebhookEndpointUpdateRequest WebhookEvent: properties: id: type: string title: Id event_type: type: string title: Event Type event_version: type: string title: Event Version source_type: type: string title: Source Type source_id: type: string title: Source Id product_id: anyOf: - type: string - type: 'null' title: Product Id payment_id: anyOf: - type: string - type: 'null' title: Payment Id membership_id: anyOf: - type: string - type: 'null' title: Membership Id receipt_id: anyOf: - type: string - type: 'null' title: Receipt Id support_ticket_id: anyOf: - type: string - type: 'null' title: Support Ticket Id created_at: anyOf: - type: string - type: 'null' title: Created At payload: type: object title: Payload deliveries: anyOf: - items: $ref: '#/components/schemas/WebhookDelivery' type: array - type: 'null' title: Deliveries additionalProperties: true type: object required: - id - event_type - event_version - source_type - source_id - product_id - payment_id - membership_id - receipt_id - support_ticket_id - created_at - payload title: WebhookEvent WebhookEventsResponse: properties: total: type: integer title: Total page: type: integer title: Page events: items: $ref: '#/components/schemas/WebhookEvent' type: array title: Events supported_events: items: type: string type: array title: Supported Events additionalProperties: true type: object required: - total - page - events - supported_events title: WebhookEventsResponse WebhookTestEventRequest: properties: event_type: type: string title: Event Type default: payment.confirmed type: object title: WebhookTestEventRequest WebhookTestResponse: properties: event: anyOf: - $ref: '#/components/schemas/WebhookEvent' - type: 'null' delivery: anyOf: - $ref: '#/components/schemas/WebhookDelivery' - type: 'null' delivered: anyOf: - type: boolean - type: 'null' title: Delivered result: anyOf: - type: object - type: 'null' title: Result additionalProperties: true type: object title: WebhookTestResponse WebhookTimelineResponse: properties: payment_id: anyOf: - type: string - type: 'null' title: Payment Id membership_id: anyOf: - type: string - type: 'null' title: Membership Id timeline: items: $ref: '#/components/schemas/WebhookEvent' type: array title: Timeline count: type: integer title: Count generated_at: type: string title: Generated At additionalProperties: true type: object required: - payment_id - membership_id - timeline - count - generated_at title: WebhookTimelineResponse WorkspaceAnalyticsResponse: properties: summary: type: object title: Summary window_assets: items: type: object type: array title: Window Assets funnel_daily: items: type: object type: array title: Funnel Daily revenue_trend_daily: items: type: object type: array title: Revenue Trend Daily source_rows: items: type: object type: array title: Source Rows product_reports: items: type: object type: array title: Product Reports attention_items: items: type: object type: array title: Attention Items expiring_memberships: items: type: object type: array title: Expiring Memberships range_start_date: type: string title: Range Start Date range_end_date: type: string title: Range End Date generated_at: type: string title: Generated At additionalProperties: true type: object required: - summary - window_assets - funnel_daily - revenue_trend_daily - source_rows - product_reports - attention_items - expiring_memberships - range_start_date - range_end_date - generated_at title: WorkspaceAnalyticsResponse ZapierHookResponse: properties: id: type: string title: Id hook_id: type: string title: Hook Id endpoint_id: anyOf: - type: string - type: 'null' title: Endpoint Id endpoint: $ref: '#/components/schemas/WebhookEndpoint' supported_events: anyOf: - items: type: string type: array - type: 'null' title: Supported Events reused: anyOf: - type: boolean - type: 'null' title: Reused additionalProperties: true type: object required: - id - hook_id - endpoint title: ZapierHookResponse ZapierHookSubscribeRequest: properties: target_url: anyOf: - type: string - type: 'null' title: Target Url targetUrl: anyOf: - type: string - type: 'null' title: Targeturl event_type: anyOf: - type: string - type: 'null' title: Event Type eventType: anyOf: - type: string - type: 'null' title: Eventtype subscribed_events: anyOf: - items: type: string type: array - type: 'null' title: Subscribed Events subscribedEvents: anyOf: - items: type: string type: array - type: 'null' title: Subscribedevents product_ids: items: type: string type: array title: Product Ids productIds: items: type: string type: array title: Productids label: anyOf: - type: string - type: 'null' title: Label type: object title: ZapierHookSubscribeRequest servers: - url: https://api.hilt.so tags: [] x-hilt-agent-commerce: offer: https://api.hilt.so/v1/agent-commerce/offer catalog: https://api.hilt.so/agent-catalog.json pricing: https://api.hilt.so/pricing x402: https://api.hilt.so/x402