Docs
Generated reference
A contract index generated from the local ATM, attested.network, and Tickets lexicons.
Compatible with the closed-beta ATM app APIs and versioned ATM event headers. Check atm-api-version on every webhook or XRPC receiver event.
Source
Generated from the local lexicon set in app/lexicons. It is the mechanical index for NSIDs, route shape, auth expectations, lifecycle labels, and record-versus-XRPC boundaries.
shell
cd app
npm run docs:generate-reference
npm run docs:checkATM money namespace
| NSID | Kind | Route | Auth | Status | Summary | Links |
|---|---|---|---|---|---|---|
| money.atmosphere.actor.getPayoutStatus | query | /xrpc/money.atmosphere.actor.getPayoutStatus | Service-auth | beta draft | Return whether an actor can receive payments through ATM. | |
| money.atmosphere.actor.getProfile | query | /xrpc/money.atmosphere.actor.getProfile | Public AppView read | beta draft | Return the indexed money.atmosphere.actor.profile record for an actor DID or handle, or null if none has been indexed. | |
| money.atmosphere.actor.profile | record | PDS | PDS record | beta draft | Minimal payment-facing profile for an Atmosphere account using ATM. | |
| money.atmosphere.analytics.getPaymentVolumeTrends | query | /xrpc/money.atmosphere.analytics.getPaymentVolumeTrends | Service-auth | beta draft | Aggregate payment-volume trends for the calling app, scoped to payments it originated. | |
| money.atmosphere.analytics.getRefundAnalysis | query | /xrpc/money.atmosphere.analytics.getRefundAnalysis | Service-auth | beta draft | Refund analysis for the calling app, scoped to its own originated payments. | |
| money.atmosphere.analytics.getSubscriptionMetrics | query | /xrpc/money.atmosphere.analytics.getSubscriptionMetrics | Service-auth | beta draft | Subscription MRR / growth / churn for the calling app, per currency, scoped to its own originated subscriptions. | |
| money.atmosphere.app.assertRecipient | procedure | /xrpc/money.atmosphere.app.assertRecipient | Service-auth | beta draft | Service-auth capability NSID used by an app to assert that a signed-in recipient (creator) DID was present when the app requested recipient approval. | |
| money.atmosphere.app.auditFeeDistributions | query | /xrpc/money.atmosphere.app.auditFeeDistributions | Service-auth | beta draft | Audit the calling app's own app-fee payout distributions for payout transparency and reconciliation. | |
| money.atmosphere.app.clearRecipientFeeShare | procedure | /xrpc/money.atmosphere.app.clearRecipientFeeShare | Service-auth | beta draft | Remove a per-recipient fee override; fee plans prepared afterward return to the app's configured fee. | |
| money.atmosphere.app.getConfig | query | /xrpc/money.atmosphere.app.getConfig | Service-auth | beta draft | Read the calling app's ATM app configuration for one environment. | |
| money.atmosphere.app.listRecipientFeeShares | query | /xrpc/money.atmosphere.app.listRecipientFeeShares | Service-auth | beta draft | List this app's per-recipient fee overrides. | |
| money.atmosphere.app.requestRecipientApproval | procedure | /xrpc/money.atmosphere.app.requestRecipientApproval | Service-auth | beta draft | Request creator approval for an app to accept ATM payments for that recipient. | |
| money.atmosphere.app.setRecipientFeeShare | procedure | /xrpc/money.atmosphere.app.setRecipientFeeShare | Service-auth | beta draft | Set a LOWER per-recipient app fee for this app (e.g. | |
| money.atmosphere.app.updateConfig | procedure | /xrpc/money.atmosphere.app.updateConfig | Service-auth | beta draft | Update safe app-level ATM configuration for one environment. | |
| money.atmosphere.authCatalog | permission-set | /xrpc/money.atmosphere.authCatalog | App service-auth | beta draft | Permission set for managing ATM-owned catalog records: products, prices, discounts, and discount codes. | |
| money.atmosphere.authProfile | permission-set | /xrpc/money.atmosphere.authProfile | App service-auth | beta draft | Permission set for creating and updating the ATM-owned payment profile record. | |
| money.atmosphere.billing.requestKofiMigrationBatch | procedure | /xrpc/money.atmosphere.billing.requestKofiMigrationBatch | Service-auth | beta draft | Create a private ATM billing migration review batch from a Ko-fi membership export. | |
| money.atmosphere.billing.requestMigrationBatch | procedure | /xrpc/money.atmosphere.billing.requestMigrationBatch | Service-auth | beta draft | Create a private ATM billing migration review batch from NORMALIZED subscriber rows an app produced from its own export (Ko-fi, Substack, Patreon, …). | |
| money.atmosphere.catalog.createProduct | procedure | /xrpc/money.atmosphere.catalog.createProduct | App service-auth | beta draft | Create an app-owned canonical ATM product in the calling app DID repo. | |
| money.atmosphere.catalog.getProduct | query | /xrpc/money.atmosphere.catalog.getProduct | Public or app-scoped read | beta draft | Return one indexed ATM catalog product by AT-URI, or null if the AppView has not indexed it. | |
| money.atmosphere.catalog.listDiscountCodes | query | /xrpc/money.atmosphere.catalog.listDiscountCodes | Public or app-scoped read | beta draft | List indexed public money.atmosphere.discountCode offers authored by a set of creators (read-only catalog projection). | |
| money.atmosphere.catalog.listProducts | query | /xrpc/money.atmosphere.catalog.listProducts | Public or app-scoped read | beta draft | List indexed ATM catalog products for a creator, with optional default price and sales-count projections. | |
| money.atmosphere.catalog.registerAppLink | procedure | /xrpc/money.atmosphere.catalog.registerAppLink | Service-auth | beta draft | Private app callback that links a creator-owned ATM product record to the app surface responsible for selling or fulfillment. | |
| money.atmosphere.catalog.updateProduct | procedure | /xrpc/money.atmosphere.catalog.updateProduct | App service-auth | beta draft | Update an app-owned canonical ATM product in the calling app DID repo. | |
| money.atmosphere.discount | record | PDS | PDS record | beta draft | Public ATM discount terms that can be mirrored to processor coupon objects at checkout. | |
| money.atmosphere.discountCode | record | PDS | PDS record | beta draft | Public customer-facing redemption code for a money.atmosphere.discount. | |
| money.atmosphere.event.list | query | /xrpc/money.atmosphere.event.list | Service-auth | beta draft | List the calling app's events in monotonic seq order for pull-based reconciliation / catch-up. | |
| money.atmosphere.event.receive | procedure | /xrpc/money.atmosphere.event.receive | Service-auth | beta draft | Optional app-implemented XRPC receiver for ATM outbound events. | |
| money.atmosphere.membership.assertMember | procedure | /xrpc/money.atmosphere.membership.assertMember | Service-auth | beta draft | Service-auth capability NSID used by a member to assert their own presence for a cross-app membership access check. | |
| money.atmosphere.membership.createProgram | procedure | /xrpc/money.atmosphere.membership.createProgram | App service-auth | beta draft | Create a portable money.atmosphere.membership.program record in the creator's repo. | |
| money.atmosphere.membership.createTier | procedure | /xrpc/money.atmosphere.membership.createTier | App service-auth | beta draft | Create a portable money.atmosphere.membership.tier record under an existing program in the creator's repo. | |
| money.atmosphere.membership.getAccess | procedure | /xrpc/money.atmosphere.membership.getAccess | Public or app-scoped read | beta draft | Cross-app membership access check. | |
| money.atmosphere.membership.listGrants | query | /xrpc/money.atmosphere.membership.listGrants | Service-auth | beta draft | List membership grants the CALLING app registered with money.atmosphere.membership.registerGrant, for reconciliation and revocation (for example: which imported members of a migration batch received grants). | |
| money.atmosphere.membership.program | record | PDS | PDS record | beta draft | Public ATM creator membership program. | |
| money.atmosphere.membership.registerGrant | procedure | /xrpc/money.atmosphere.membership.registerGrant | Service-auth | beta draft | Register a non-payment membership grant (comp, migration import, or free-tier claim) so cross-app access checks honor it: money.atmosphere.membership.getAccess answers from the union of attested subscription truth and registered grants. | |
| money.atmosphere.membership.revokeGrant | procedure | /xrpc/money.atmosphere.membership.revokeGrant | Service-auth | beta draft | Revoke a membership grant previously registered with money.atmosphere.membership.registerGrant. | |
| money.atmosphere.membership.tier | record | PDS | PDS record | beta draft | Public ATM membership tier for a creator membership program. | |
| money.atmosphere.membership.updateProgram | procedure | /xrpc/money.atmosphere.membership.updateProgram | App service-auth | beta draft | Update a money.atmosphere.membership.program record ATM authored in the creator's repo (the record CID rotates). | |
| money.atmosphere.membership.updateTier | procedure | /xrpc/money.atmosphere.membership.updateTier | App service-auth | beta draft | Update a money.atmosphere.membership.tier record ATM authored in the creator's repo (the record CID rotates). | |
| money.atmosphere.payment.assertPayer | procedure | /xrpc/money.atmosphere.payment.assertPayer | Service-auth | beta draft | Service-auth capability NSID used by an app to assert that a signed-in payer DID was present for an ATM checkout. | |
| money.atmosphere.payment.cancelPledge | procedure | /xrpc/money.atmosphere.payment.cancelPledge | Service-auth | beta draft | Cancel a pledge before it converts. | |
| money.atmosphere.payment.cancelSubscription | procedure | /xrpc/money.atmosphere.payment.cancelSubscription | Service-auth | beta draft | Cancel a subscription on behalf of the authenticated payer. | |
| money.atmosphere.payment.convertPledges | procedure | /xrpc/money.atmosphere.payment.convertPledges | Service-auth | beta draft | Convert this app's eligible active pledges for a recipient into live subscriptions now (e.g. | |
| money.atmosphere.payment.createManagementSession | procedure | /xrpc/money.atmosphere.payment.createManagementSession | Service-auth | beta draft | Create a short-lived, single-use subscription management URL for a payer without an ATM sign-in. | |
| money.atmosphere.payment.createPledge | procedure | /xrpc/money.atmosphere.payment.createPledge | Service-auth | beta draft | Create a pledge: the payer saves a card for a recipient who has not finished ATM payment setup, and ATM converts it into a real subscription when the recipient becomes payable and has approved this app. | |
| money.atmosphere.payment.createSubscriptionChangeSession | procedure | /xrpc/money.atmosphere.payment.createSubscriptionChangeSession | App service-auth | beta draft | Create a short-lived ATM hosted URL for a previously previewed membership tier change. | |
| money.atmosphere.payment.declineRecord | procedure | /xrpc/money.atmosphere.payment.declineRecord | Service-auth | beta draft | Signal that the originating app cannot write a delegated record. | |
| money.atmosphere.payment.diagnoseSubscriptionFailure | query | /xrpc/money.atmosphere.payment.diagnoseSubscriptionFailure | Service-auth | beta draft | Diagnose why a subscription renewal failed, for the originating app. | |
| money.atmosphere.payment.getSubscriptionChange | query | /xrpc/money.atmosphere.payment.getSubscriptionChange | Service-auth | beta draft | Return one known membership tier-change status to the registered app that requested that change. | |
| money.atmosphere.payment.listPayerProofs | query | /xrpc/money.atmosphere.payment.listPayerProofs | Public or app-scoped read | beta draft | List the public attested.network payment records anchored to a payer DID (the payer's own already-public payment history), filtered to records with an active broker proof. | |
| money.atmosphere.payment.listPendingRecords | query | /xrpc/money.atmosphere.payment.listPendingRecords | Service-auth | beta draft | List pending payer/creator records the originating app may upgrade. | |
| money.atmosphere.payment.listPledges | query | /xrpc/money.atmosphere.payment.listPledges | Service-auth | beta draft | List pledges originated by the authenticated app. | |
| money.atmosphere.payment.listSubscriptions | query | /xrpc/money.atmosphere.payment.listSubscriptions | Service-auth | beta draft | List active subscriptions for the authenticated payer. | |
| money.atmosphere.payment.previewSubscriptionChange | procedure | /xrpc/money.atmosphere.payment.previewSubscriptionChange | App service-auth | beta draft | Create a short-lived ATM-authored membership tier-change quote without changing billing or access. | |
| money.atmosphere.payment.refund | procedure | /xrpc/money.atmosphere.payment.refund | Service-auth | beta draft | Refund a payment the calling app originated. | |
| money.atmosphere.payment.registerCreatorProof | procedure | /xrpc/money.atmosphere.payment.registerCreatorProof | Service-auth | beta draft | Register a creator proof URI written by the originating app on the creator's PDS via OAuth. | |
| money.atmosphere.payment.registerPayerRecord | procedure | /xrpc/money.atmosphere.payment.registerPayerRecord | Service-auth | beta draft | Register a payer record URI written by the originating app on the payer's PDS via OAuth. | |
| money.atmosphere.payment.verifyRecord | query | /xrpc/money.atmosphere.payment.verifyRecord | Public AppView read | beta draft | Verify one exact public attested payment strongRef against ATM's current active broker proof. | |
| money.atmosphere.price | record | PDS | PDS record | beta draft | Public ATM price record describing amount, currency, and billing cadence for a product. | |
| money.atmosphere.product | record | PDS | PDS record | beta draft | Public ATM catalog product describing what is sold; prices live in money.atmosphere.price. | |
| money.atmosphere.segments.listMembers | query | /xrpc/money.atmosphere.segments.listMembers | Service-auth | beta draft | List members of a private customer cohort the calling app's payments computed. | |
| money.atmosphere.segments.requestMessage | procedure | /xrpc/money.atmosphere.segments.requestMessage | Service-auth | beta draft | Request a marketing message to a computed customer cohort. |
ATM money fields
money.atmosphere.actor.getPayoutStatus18 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | actor | string | yes | no | format:at-identifier | No description in lexicon yet. |
| output | status | string<active | action_required | pending | not_ready | temporarily_unavailable> | yes | no | maxLength:64 | Synthesized payout readiness. |
| output | chargesEnabled | boolean | yes | no | none | No description in lexicon yet. |
| output | payoutsEnabled | boolean | yes | no | none | No description in lexicon yet. |
| output | detailsSubmitted | boolean | yes | no | none | No description in lexicon yet. |
| output | requirementsDue | array<string> | no | no | maxLength:100 | No description in lexicon yet. |
| output | currentlyDue | integer | no | no | none | No description in lexicon yet. |
| output | pastDue | integer | no | no | none | No description in lexicon yet. |
| output | eventuallyDue | integer | no | no | none | No description in lexicon yet. |
| output | disabledReason | string | no | no | maxLength:128 | No description in lexicon yet. |
| output | currentDeadline | string | no | no | format:datetime | No description in lexicon yet. |
| output | errors | array<string> | no | no | maxLength:100 | No description in lexicon yet. |
| output | message | string | no | no | maxLength:512 | No description in lexicon yet. |
| output | accountLinked | boolean | no | no | none | No description in lexicon yet. |
| output | supportRequired | boolean | no | no | none | No description in lexicon yet. |
| output | hasHistory | boolean | no | no | none | No description in lexicon yet. |
| output | internalOwner | boolean | no | no | none | No description in lexicon yet. |
| output | sameLegalEntity | boolean | no | no | none | No description in lexicon yet. |
money.atmosphere.actor.getProfile5 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | actor | string | yes | no | format:at-identifier | No description in lexicon yet. |
| output | profile | ref:#profile | yes | yes | none | Either null or { uri, cid, value } where value is money.atmosphere.actor.profile. |
| def:profile | uri | string | yes | no | format:at-uri | No description in lexicon yet. |
| def:profile | cid | string | yes | no | format:cid | No description in lexicon yet. |
| def:profile | value | ref:money.atmosphere.actor.profile | yes | no | none | No description in lexicon yet. |
money.atmosphere.actor.profile5 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | displayName | string | no | no | maxLength:640, maxGraphemes:64 | Payment-facing display name. |
| record | description | string | no | no | maxLength:2560, maxGraphemes:256 | Short payment-facing profile text. |
| record | avatar | blob | no | no | none | Payment-facing avatar image. |
| record | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| record | updatedAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.analytics.getPaymentVolumeTrends25 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | environment | string<test | live> | no | no | maxLength:8 | Which app environment to report on. |
| params | granularity | string<hour | day> | no | no | maxLength:8 | Time-bucket size. |
| params | windowDays | integer | no | no | minimum:1, maximum:92 | Lookback window in days from now. |
| params | currency | string | no | no | minLength:3, maxLength:3 | Optional lowercase ISO 4217 filter. |
| output | series | array<ref:#bucket> | yes | no | none | No description in lexicon yet. |
| output | byMethod | array<ref:#methodStat> | yes | no | none | No description in lexicon yet. |
| output | byCurrency | array<ref:#currencyStat> | yes | no | none | No description in lexicon yet. |
| output | window | ref:#window | yes | no | none | No description in lexicon yet. |
| def:bucket | bucket | string | yes | no | format:datetime | Start of the time bucket (UTC). |
| def:bucket | currency | string | yes | no | minLength:3, maxLength:3 | Lowercase ISO 4217. |
| def:bucket | count | integer | yes | no | none | All payments in the bucket. |
| def:bucket | successCount | integer | yes | no | none | Payments with a settled status in the bucket. |
| def:bucket | grossAmount | integer | yes | no | none | Gross settled volume for this currency in the bucket. |
| def:methodStat | method | string | yes | no | maxLength:32 | Payment method type (e.g. |
| def:methodStat | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:methodStat | count | integer | yes | no | none | No description in lexicon yet. |
| def:methodStat | grossAmount | integer | yes | no | none | No description in lexicon yet. |
| def:currencyStat | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:currencyStat | count | integer | yes | no | none | No description in lexicon yet. |
| def:currencyStat | successCount | integer | yes | no | none | No description in lexicon yet. |
| def:currencyStat | grossAmount | integer | yes | no | none | No description in lexicon yet. |
| def:window | granularity | string | yes | no | maxLength:8 | No description in lexicon yet. |
| def:window | windowDays | integer | yes | no | none | No description in lexicon yet. |
| def:window | from | string | yes | no | format:datetime | No description in lexicon yet. |
| def:window | to | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.analytics.getRefundAnalysis19 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | environment | string<test | live> | no | no | maxLength:8 | No description in lexicon yet. |
| params | windowDays | integer | no | no | minimum:1, maximum:92 | No description in lexicon yet. |
| params | currency | string | no | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| output | byReason | array<ref:#reasonStat> | yes | no | none | No description in lexicon yet. |
| output | summary | array<ref:#currencySummary> | yes | no | none | No description in lexicon yet. |
| output | window | ref:#window | yes | no | none | No description in lexicon yet. |
| def:reasonStat | reasonCode | string | yes | no | maxLength:32 | Refund reason code, or 'unspecified'. |
| def:reasonStat | status | string | yes | no | maxLength:24 | No description in lexicon yet. |
| def:reasonStat | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:reasonStat | count | integer | yes | no | none | No description in lexicon yet. |
| def:reasonStat | amount | integer | yes | no | none | No description in lexicon yet. |
| def:currencySummary | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:currencySummary | refundCount | integer | yes | no | none | No description in lexicon yet. |
| def:currencySummary | refundedAmount | integer | yes | no | none | No description in lexicon yet. |
| def:currencySummary | settledCount | integer | yes | no | none | Settled payments in window — denominator for refund rate. |
| def:currencySummary | settledGrossAmount | integer | yes | no | none | No description in lexicon yet. |
| def:window | windowDays | integer | yes | no | none | No description in lexicon yet. |
| def:window | from | string | yes | no | format:datetime | No description in lexicon yet. |
| def:window | to | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.analytics.getSubscriptionMetrics14 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | environment | string<test | live> | no | no | maxLength:8 | No description in lexicon yet. |
| params | windowDays | integer | no | no | minimum:1, maximum:92 | No description in lexicon yet. |
| params | currency | string | no | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| output | byCurrency | array<ref:#currencyMetrics> | yes | no | none | No description in lexicon yet. |
| output | window | ref:#window | yes | no | none | No description in lexicon yet. |
| output | notes | array<string> | yes | no | none | No description in lexicon yet. |
| def:currencyMetrics | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:currencyMetrics | activeCount | integer | yes | no | none | No description in lexicon yet. |
| def:currencyMetrics | mrr | integer | yes | no | none | Interval-normalized monthly recurring revenue (current active snapshot). |
| def:currencyMetrics | newCount | integer | yes | no | none | Subscriptions created in the window. |
| def:currencyMetrics | canceledCount | integer | yes | no | none | Subscriptions canceled in the window (by canceledAt). |
| def:window | windowDays | integer | yes | no | none | No description in lexicon yet. |
| def:window | from | string | yes | no | format:datetime | No description in lexicon yet. |
| def:window | to | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.app.assertRecipient2 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | recipientDid | string | yes | no | format:did | The recipient (creator) DID asserted by the app-held user session. |
| output | accepted | boolean | yes | no | none | No description in lexicon yet. |
money.atmosphere.app.auditFeeDistributions22 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | cursor | string | no | no | maxLength:128 | Opaque keyset cursor from a prior page. |
| params | environment | string<test | live> | no | no | maxLength:8 | Which app environment's payouts to return. |
| params | paymentId | string | no | no | maxLength:128 | Optional filter to a single originating payment. |
| params | status | string<queued | scheduled | transferred | held | reversed | failed> | no | no | maxLength:16 | Optional filter to one synthesized payout status. |
| params | limit | integer | no | no | minimum:1, maximum:200 | No description in lexicon yet. |
| output | distributions | array<ref:#distribution> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:128 | Keyset cursor for the next page; absent when no more rows. |
| def:distribution | id | string | yes | no | maxLength:128 | Distribution row id. |
| def:distribution | paymentId | string | yes | no | maxLength:128 | The originating payment id (the app-visible payment id). |
| def:distribution | chargeId | string | no | no | maxLength:256 | Processor charge/invoice id this distribution settled against. |
| def:distribution | role | string | yes | no | maxLength:32 | Distribution role. |
| def:distribution | amount | integer | yes | no | none | Gross app-fee amount for this distribution, in the smallest currency unit. |
| def:distribution | currency | string | yes | no | minLength:3, maxLength:3 | Lowercase ISO 4217. |
| def:distribution | status | string<queued | scheduled | transferred | held | reversed | failed> | yes | no | maxLength:16 | Synthesized payout status. |
| def:distribution | heldReason | string | no | no | maxLength:512 | Operator-authored reason a queued transfer is held (only set when status = held). |
| def:distribution | heldUntil | string | no | no | format:datetime | Scheduled payout time. |
| def:distribution | processorTransferId | string | no | no | maxLength:256 | Rail-agnostic processor transfer id for the payout movement (e.g. |
| def:distribution | clawbackStatus | string<pending | reversed | failed | waived> | no | no | maxLength:16 | Partial-refund clawback state of an already-transferred app share. |
| def:distribution | clawbackAmount | integer | yes | no | none | Amount of this app-fee share clawed back by a partial refund, in the smallest currency unit. |
| def:distribution | processorReversalId | string | no | no | maxLength:256 | Rail-agnostic processor reversal id for the clawback/reversal movement. |
| def:distribution | period | string | no | no | maxLength:16 | Optional operator grouping period. |
| def:distribution | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.app.getConfig61 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| def:modules | payments | boolean | yes | no | none | No description in lexicon yet. |
| def:modules | products | boolean | yes | no | none | No description in lexicon yet. |
| def:modules | subscriptions | boolean | yes | no | none | No description in lexicon yet. |
| def:modules | pledges | boolean | no | no | none | No description in lexicon yet. |
| def:modules | tickets | boolean | yes | no | none | No description in lexicon yet. |
| def:modules | machinePayments | boolean | no | no | none | Planned machine-payments (MPP/x402) module. |
| def:subscriptionPolicy | activeLimit | string<multiple | one-per-payer-recipient> | yes | no | maxLength:64 | No description in lexicon yet. |
| def:ticketing | qrPasses | boolean | yes | no | none | No description in lexicon yet. |
| def:ticketing | walletPasses | boolean | yes | no | none | No description in lexicon yet. |
| def:ticketFee | bps | integer | yes | no | minimum:0, maximum:1000 | ATM-owned ticket processing fee percentage in basis points. |
| def:ticketFee | flatAmount | integer | yes | no | minimum:0, maximum:1000 | ATM-owned flat ticket processing fee in cents per paid ticket. |
| def:ticketFee | passToBuyer | boolean | yes | no | none | Whether the ATM ticket processing fee is added to buyer checkout price instead of absorbed by the organizer. |
| def:payout | holdDays | integer | yes | no | minimum:0, maximum:90 | App-fee payout hold in days. |
| def:feeTier | subscriptionGroupKey | string | yes | no | maxLength:128 | The app-owned plan that grants this tier, matched against a settling subscription's subscriptionGroupKey. |
| def:feeTier | feeShareBps | integer | yes | no | minimum:0, maximum:10000 | Lowered app fee (basis points) for that subscriber's creator revenue. |
| def:feeTier | label | string | no | no | maxLength:64 | Optional label; stored as the resulting override's reason. |
| def:checkout | theme | string<auto | light | dark> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:paymentMethods | enabled | array<string<card | link | apple_pay | google_pay | us_bank_account | klarna>> | yes | no | maxLength:12 | No description in lexicon yet. |
| def:paymentMethods | disabled | array<string<card | link | apple_pay | google_pay | us_bank_account | klarna>> | yes | no | maxLength:12 | No description in lexicon yet. |
| def:paymentMethods | dynamicPaymentMethods | boolean | yes | no | none | No description in lexicon yet. |
| def:publicRecordPaymentPolicy | appRecord | string<public | private> | no | no | maxLength:16 | No description in lexicon yet. |
| def:publicRecordPaymentPolicy | attestation | string<public | private> | no | no | maxLength:16 | No description in lexicon yet. |
| def:publicRecordsPolicy | enabled | boolean | yes | no | none | Master switch: when false ATM writes no public attested record for this app regardless of per-payment-type visibility. |
| def:publicRecordsPolicy | defaults | ref:#publicRecordPaymentPolicy | yes | no | none | No description in lexicon yet. |
| def:publicRecordsPolicy | byPaymentType | ref:#publicRecordsPolicyByPaymentType | yes | no | none | No description in lexicon yet. |
| def:xrpcReceiver | serviceRef | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:xrpcReceiver | method | string | yes | no | maxLength:300, format:nsid | XRPC receiver method NSID. |
| def:eventDelivery | transport | string<webhook | xrpc> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:eventDelivery | xrpcReceiver | ref:#xrpcReceiver | yes | no | none | No description in lexicon yet. |
| def:webhookEventSetting | type | string<app.webhook.test | payment.completed | payment.failed | payment.refunded | payment.refund-updated | payment.disputed | payment.dispute-closed | subscription.invoice-paid | subscription.change-updated | subscription.updated | subscription.canceled | subscription.payment-failed | subscription.recovered | pledge.created | pledge.canceled | pledge.converted | pledge.conversion-failed | payer.record.requested | payer.claimed | creator.proof.requested | attestation.updated | product.updated | product.archived | product.deleted | ticket.hold.created | ticket.hold.expired | tickets.issued | ticket.event-canceled | ticket.voided | ticket.refunded | ticket.checked-in | ticket.form-submitted | ticket.waitlist.joined | ticket.waitlist.offered | ticket.collaboration.invited | ticket.collaboration.accepted | ticket.collaboration.revoked | customer.segment.message-requested | recipient.authorization.updated> | yes | no | maxLength:128 | ATM webhook event type, such as payment.completed. |
| def:webhookEventSetting | enabled | boolean | yes | no | none | No description in lexicon yet. |
| def:webhook | configured | boolean | yes | no | none | No description in lexicon yet. |
| def:webhook | url | string | yes | yes | format:uri | No description in lexicon yet. |
| def:webhook | paused | boolean | yes | no | none | No description in lexicon yet. |
| def:webhook | secretRotatedAt | string | yes | yes | format:datetime | No description in lexicon yet. |
| def:webhook | previousSecretExpiresAt | string | yes | yes | format:datetime | No description in lexicon yet. |
| def:config | appDid | string | yes | no | format:did | No description in lexicon yet. |
| def:config | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| def:config | status | string<active | sandbox> | yes | no | maxLength:32 | App-environment status. |
| def:config | appUrl | string | yes | yes | format:uri | No description in lexicon yet. |
| def:config | feeShareBps | integer | yes | no | minimum:0, maximum:10000 | No description in lexicon yet. |
| def:config | webhook | ref:#webhook | yes | no | none | No description in lexicon yet. |
| def:config | appConfig | ref:#configAppConfig | yes | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | tip | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | subscribe | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | shop | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | commission | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | ticket | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:configAppConfig | modules | ref:#modules | yes | no | none | No description in lexicon yet. |
| def:configAppConfig | subscriptionPolicy | ref:#subscriptionPolicy | yes | no | none | No description in lexicon yet. |
| def:configAppConfig | ticketing | ref:#ticketing | yes | no | none | No description in lexicon yet. |
| def:configAppConfig | ticketFee | ref:#ticketFee | yes | no | none | No description in lexicon yet. |
| def:configAppConfig | payout | ref:#payout | yes | no | none | No description in lexicon yet. |
| def:configAppConfig | checkout | ref:#checkout | yes | no | none | No description in lexicon yet. |
| def:configAppConfig | paymentMethods | ref:#paymentMethods | yes | no | none | No description in lexicon yet. |
| def:configAppConfig | publicRecords | ref:#publicRecordsPolicy | yes | no | none | No description in lexicon yet. |
| def:configAppConfig | eventDelivery | ref:#eventDelivery | yes | no | none | No description in lexicon yet. |
| def:configAppConfig | webhookEvents | array<ref:#webhookEventSetting> | yes | no | maxLength:128 | No description in lexicon yet. |
| def:configAppConfig | atmSupportBps | integer | yes | no | minimum:0, maximum:10000 | No description in lexicon yet. |
| def:configAppConfig | feeTiers | array<ref:#feeTier> | yes | no | maxLength:20 | Declarative variable-app-fee tiers (up to 20): each maps one of the app's own subscription plans to a lower app fee auto-applied to that subscriber's creator revenue. |
money.atmosphere.app.requestRecipientApproval31 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | recipientDid | string | yes | no | format:did | No description in lexicon yet. |
| input | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| input | paymentTypes | array<string<tip | subscribe | shop | commission | ticket>> | yes | no | minLength:1, maxLength:32 | No description in lexicon yet. |
| input | feeShareBps | integer | no | no | minimum:0, maximum:10000 | App fee cap requested for this recipient, in basis points of the gross payment. |
| input | publicRecords | ref:#publicRecordsPolicy | no | no | none | No description in lexicon yet. |
| input | requestReason | string | no | no | maxLength:3000, maxGraphemes:300 | No description in lexicon yet. |
| input | setupReturnUrl | string | no | no | format:uri | No description in lexicon yet. |
| input | recipientAssertionJwt | string | no | no | maxLength:4096 | Optional short-lived recipient (creator) presence token: a com.atproto.server.getServiceAuth JWT with iss = recipientDid, aud = ATM broker, lxm = money.atmosphere.app.assertRecipient. |
| output | id | string | yes | no | maxLength:128 | No description in lexicon yet. |
| output | status | string<pending | approved | blocked | revoked | needs-review> | yes | no | maxLength:32 | No description in lexicon yet. |
| output | dashboardUrl | string | yes | no | format:uri | No description in lexicon yet. |
| output | onboardingUrl | string | no | no | format:uri | ATM-hosted URL where the creator can finish payment setup. |
| output | paymentTypes | array<string<tip | subscribe | shop | commission | ticket>> | yes | no | maxLength:32 | No description in lexicon yet. |
| output | feeShareBps | integer | yes | no | minimum:0, maximum:10000 | No description in lexicon yet. |
| output | ticketFee | ref:#ticketFee | no | no | none | Exact ATM ticket fee terms included in the pending approval when paymentTypes contains ticket. |
| output | materialChangeReasons | array<string> | no | no | maxLength:32 | Which requested terms materially changed versus the existing approval (empty when none). |
| output | autoApproved | boolean | no | no | none | Deprecated compatibility field. |
| output | needsPaymentSetup | boolean | no | no | none | True when the app should route the creator through ATM to finish setup. |
| def:publicRecordPaymentPolicy | appRecord | string<public | private> | no | no | maxLength:16 | No description in lexicon yet. |
| def:publicRecordPaymentPolicy | attestation | string<public | private> | no | no | maxLength:16 | No description in lexicon yet. |
| def:publicRecordsPolicy | enabled | boolean | no | no | none | Whether this app may send explicit payer-facing public payment record choices for this recipient scope. |
| def:publicRecordsPolicy | defaults | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicy | byPaymentType | ref:#publicRecordsPolicyByPaymentType | no | no | none | No description in lexicon yet. |
| def:ticketFee | bps | integer | yes | no | minimum:0, maximum:1000 | No description in lexicon yet. |
| def:ticketFee | flatAmount | integer | yes | no | minimum:0, maximum:1000 | No description in lexicon yet. |
| def:ticketFee | passToBuyer | boolean | yes | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | tip | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | subscribe | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | shop | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | commission | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | ticket | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
money.atmosphere.app.updateConfig47 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| input | appUrl | string | no | yes | format:uri | No description in lexicon yet. |
| input | webhookUrl | string | no | yes | format:uri | No description in lexicon yet. |
| input | webhookPaused | boolean | no | no | none | No description in lexicon yet. |
| input | feeShareBps | integer | no | no | minimum:0, maximum:10000 | No description in lexicon yet. |
| input | atmSupportBps | integer | no | no | minimum:0, maximum:10000 | No description in lexicon yet. |
| input | modules | ref:#modules | no | no | none | Writable module toggles. |
| input | subscriptionPolicy | ref:#subscriptionPolicy | no | no | none | No description in lexicon yet. |
| input | ticketing | ref:#ticketing | no | no | none | No description in lexicon yet. |
| input | ticketFee | ref:#ticketFee | no | no | none | No description in lexicon yet. |
| input | payout | ref:#payout | no | no | none | No description in lexicon yet. |
| input | checkout | ref:#checkout | no | no | none | No description in lexicon yet. |
| input | paymentMethods | ref:#paymentMethods | no | no | none | No description in lexicon yet. |
| input | publicRecords | ref:#publicRecordsPolicy | no | no | none | No description in lexicon yet. |
| input | eventDelivery | ref:#eventDelivery | no | no | none | No description in lexicon yet. |
| input | webhookEvents | array<ref:#webhookEventSetting> | no | no | maxLength:128 | No description in lexicon yet. |
| input | feeTiers | array<ref:money.atmosphere.app.getConfig#feeTier> | no | no | maxLength:20 | Full replacement of the app's variable-app-fee tiers (up to 20). |
| def:publicRecordPaymentPolicy | appRecord | string<public | private> | no | no | maxLength:16 | No description in lexicon yet. |
| def:publicRecordPaymentPolicy | attestation | string<public | private> | no | no | maxLength:16 | No description in lexicon yet. |
| def:publicRecordsPolicy | enabled | boolean | no | no | none | Master switch: when false ATM writes no public attested record for this app regardless of per-payment-type visibility. |
| def:publicRecordsPolicy | defaults | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicy | byPaymentType | ref:#publicRecordsPolicyByPaymentType | no | no | none | No description in lexicon yet. |
| def:webhookEventSetting | type | string<app.webhook.test | payment.completed | payment.failed | payment.refunded | payment.refund-updated | payment.disputed | payment.dispute-closed | subscription.invoice-paid | subscription.change-updated | subscription.updated | subscription.canceled | subscription.payment-failed | subscription.recovered | pledge.created | pledge.canceled | pledge.converted | pledge.conversion-failed | payer.record.requested | payer.claimed | creator.proof.requested | attestation.updated | product.updated | product.archived | product.deleted | ticket.hold.created | ticket.hold.expired | tickets.issued | ticket.event-canceled | ticket.voided | ticket.refunded | ticket.checked-in | ticket.form-submitted | ticket.waitlist.joined | ticket.waitlist.offered | ticket.collaboration.invited | ticket.collaboration.accepted | ticket.collaboration.revoked | customer.segment.message-requested | recipient.authorization.updated> | yes | no | maxLength:128 | ATM webhook event type, such as payment.completed. |
| def:webhookEventSetting | enabled | boolean | yes | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | tip | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | subscribe | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | shop | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | commission | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:publicRecordsPolicyByPaymentType | ticket | ref:#publicRecordPaymentPolicy | no | no | none | No description in lexicon yet. |
| def:modules | payments | boolean | no | no | none | No description in lexicon yet. |
| def:modules | products | boolean | no | no | none | No description in lexicon yet. |
| def:modules | subscriptions | boolean | no | no | none | No description in lexicon yet. |
| def:modules | pledges | boolean | no | no | none | No description in lexicon yet. |
| def:modules | tickets | boolean | no | no | none | No description in lexicon yet. |
| def:subscriptionPolicy | activeLimit | string<multiple | one-per-payer-recipient> | no | no | maxLength:64 | No description in lexicon yet. |
| def:ticketing | qrPasses | boolean | no | no | none | No description in lexicon yet. |
| def:ticketing | walletPasses | boolean | no | no | none | No description in lexicon yet. |
| def:ticketFee | passToBuyer | boolean | no | no | none | Who pays ATM's configured ticket processing fee. |
| def:payout | holdDays | integer | no | no | minimum:0, maximum:90 | No description in lexicon yet. |
| def:checkout | theme | string<auto | light | dark> | no | no | maxLength:16 | No description in lexicon yet. |
| def:paymentMethods | enabled | array<string<card | link | apple_pay | google_pay | us_bank_account | klarna>> | no | no | maxLength:12 | No description in lexicon yet. |
| def:paymentMethods | disabled | array<string<card | link | apple_pay | google_pay | us_bank_account | klarna>> | no | no | maxLength:12 | No description in lexicon yet. |
| def:paymentMethods | dynamicPaymentMethods | boolean | no | no | none | No description in lexicon yet. |
| def:eventDelivery | transport | string<webhook | xrpc> | no | no | maxLength:16 | No description in lexicon yet. |
| def:eventDelivery | xrpcReceiver | ref:#eventDeliveryXrpcReceiver | no | no | none | No description in lexicon yet. |
| def:eventDeliveryXrpcReceiver | serviceRef | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:eventDeliveryXrpcReceiver | method | string | no | no | maxLength:300, format:nsid | No description in lexicon yet. |
money.atmosphere.authCatalog0 fields
No top-level fields are defined for this lexicon.
money.atmosphere.authProfile0 fields
No top-level fields are defined for this lexicon.
money.atmosphere.billing.requestKofiMigrationBatch42 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | creatorDid | string | yes | no | format:did | No description in lexicon yet. |
| input | csvText | string | yes | no | maxLength:1000000 | Raw Ko-fi membership CSV. |
| input | environment | string<test | live> | no | no | maxLength:8 | No description in lexicon yet. |
| input | importSource | string<kofi | substack> | no | no | maxLength:64 | Source platform: Ko-fi (default) or Substack. |
| input | dryRun | boolean | no | no | none | Preview only: parse the CSV and return summary/tiers/warnings WITHOUT persisting a review batch (batch and dashboardUrl are omitted from the response). |
| input | requestedCutoverAt | string | no | no | format:datetime | No description in lexicon yet. |
| input | metadata | unknown | no | no | none | App-private migration context such as app-local creator/list ids. |
| output | dryRun | boolean | no | no | none | True when the request was a dry run: no batch was persisted, so batch and dashboardUrl are omitted. |
| output | batch | ref:#batch | no | no | none | No description in lexicon yet. |
| output | dashboardUrl | string | no | no | format:uri | No description in lexicon yet. |
| output | summary | ref:#previewSummary | yes | no | none | No description in lexicon yet. |
| output | tiers | array<ref:#tierSummary> | yes | no | none | No description in lexicon yet. |
| output | warnings | array<string> | yes | no | none | No description in lexicon yet. |
| def:previewSummary | source | string<kofi | substack> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:previewSummary | totalRows | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | validRows | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | activeRows | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | stripeRows | integer | no | no | minimum:0 | Rows whose source payment method was Stripe. |
| def:previewSummary | paypalRows | integer | no | no | minimum:0 | Rows whose source payment method was PayPal. |
| def:previewSummary | unknownPaymentMethodRows | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | missingEmailRows | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | duplicateEmailRows | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | totalAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | currencies | array<string> | yes | no | maxLength:20 | No description in lexicon yet. |
| def:previewSummary | tierCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | tierName | string | yes | no | maxLength:512, maxGraphemes:120 | No description in lexicon yet. |
| def:tierSummary | rowCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | activeCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | stripeCount | integer | no | no | minimum:0 | Rows in this tier whose source payment method was Stripe. |
| def:tierSummary | paypalCount | integer | no | no | minimum:0 | Rows in this tier whose source payment method was PayPal. |
| def:tierSummary | unknownPaymentMethodCount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | totalAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | currencies | array<string> | yes | no | maxLength:20 | No description in lexicon yet. |
| def:batch | id | string | yes | no | maxLength:128 | No description in lexicon yet. |
| def:batch | status | string | yes | no | maxLength:64 | No description in lexicon yet. |
| def:batch | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| def:batch | importSource | string<kofi | substack> | yes | no | maxLength:64 | No description in lexicon yet. |
| def:batch | migrationPath | string | yes | no | maxLength:128 | No description in lexicon yet. |
| def:batch | creatorDid | string | yes | no | format:did | No description in lexicon yet. |
| def:batch | destinationAccountId | string | no | no | maxLength:128 | The creator's ATM connected-account id — the PAN-copy destination the app surfaces to the creator. |
| def:batch | appDid | string | no | no | format:did | No description in lexicon yet. |
| def:batch | requestedCutoverAt | string | no | no | format:datetime | No description in lexicon yet. |
money.atmosphere.billing.requestMigrationBatch51 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | creatorDid | string | yes | no | format:did | No description in lexicon yet. |
| input | rows | array<ref:#subscriberRow> | yes | no | maxLength:50000 | Normalized subscriber rows the app produced from its own export. |
| input | source | string<kofi | substack> | no | no | maxLength:64 | Provenance label for the export (Ko-fi, Substack, …). |
| input | environment | string<test | live> | no | no | maxLength:8 | No description in lexicon yet. |
| input | dryRun | boolean | no | no | none | Preview only: return summary/tiers/warnings WITHOUT persisting a review batch (batch and dashboardUrl are omitted from the response). |
| input | requestedCutoverAt | string | no | no | format:datetime | No description in lexicon yet. |
| input | metadata | unknown | no | no | none | App-private migration context such as app-local creator/list ids. |
| output | dryRun | boolean | no | no | none | True when the request was a dry run: no batch was persisted, so batch and dashboardUrl are omitted. |
| output | batch | ref:#batch | no | no | none | No description in lexicon yet. |
| output | dashboardUrl | string | no | no | format:uri | No description in lexicon yet. |
| output | summary | ref:#previewSummary | yes | no | none | No description in lexicon yet. |
| output | tiers | array<ref:#tierSummary> | yes | no | none | No description in lexicon yet. |
| output | warnings | array<string> | yes | no | none | No description in lexicon yet. |
| def:previewSummary | source | string<kofi | substack> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:previewSummary | totalRows | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | validRows | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | activeRows | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | stripeRows | integer | no | no | minimum:0 | Rows whose source payment method was Stripe. |
| def:previewSummary | paypalRows | integer | no | no | minimum:0 | Rows whose source payment method was PayPal. |
| def:previewSummary | unknownPaymentMethodRows | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | missingEmailRows | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | duplicateEmailRows | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | totalAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | currencies | array<string> | yes | no | maxLength:20 | No description in lexicon yet. |
| def:previewSummary | tierCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | tierName | string | yes | no | maxLength:512, maxGraphemes:120 | No description in lexicon yet. |
| def:tierSummary | rowCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | activeCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | stripeCount | integer | no | no | minimum:0 | Rows in this tier whose source payment method was Stripe. |
| def:tierSummary | paypalCount | integer | no | no | minimum:0 | Rows in this tier whose source payment method was PayPal. |
| def:tierSummary | unknownPaymentMethodCount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | totalAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | currencies | array<string> | yes | no | maxLength:20 | No description in lexicon yet. |
| def:subscriberRow | emailHash | string | no | no | maxLength:128 | Lowercase-hex SHA-256 of the trimmed, lowercased subscriber email — the join key to the Stripe PAN-copy customer mapping at cutover. |
| def:subscriberRow | maskedEmail | string | no | no | maxLength:320, maxGraphemes:160 | Display-only masked email such as ad*@example.com. |
| def:subscriberRow | displayName | string | no | no | maxLength:512, maxGraphemes:120 | No description in lexicon yet. |
| def:subscriberRow | status | string | no | no | maxLength:128 | Source-native status text, for display/audit only. |
| def:subscriberRow | active | boolean | yes | no | none | Whether the subscription is currently active. |
| def:subscriberRow | paymentMethod | string<stripe | paypal | unknown> | yes | no | maxLength:32 | Only stripe rows are migratable; paypal/unknown are surfaced for creator review. |
| def:subscriberRow | tierName | string | no | no | maxLength:512, maxGraphemes:120 | No description in lexicon yet. |
| def:subscriberRow | amount | integer | no | no | minimum:0 | Per-subscriber amount in the currency minor unit. |
| def:subscriberRow | currency | string | no | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code. |
| def:batch | id | string | yes | no | maxLength:128 | No description in lexicon yet. |
| def:batch | status | string | yes | no | maxLength:64 | No description in lexicon yet. |
| def:batch | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| def:batch | importSource | string<kofi | substack> | yes | no | maxLength:64 | No description in lexicon yet. |
| def:batch | migrationPath | string | yes | no | maxLength:128 | No description in lexicon yet. |
| def:batch | creatorDid | string | yes | no | format:did | No description in lexicon yet. |
| def:batch | destinationAccountId | string | no | no | maxLength:128 | The creator's ATM connected-account id — the PAN-copy destination the app surfaces to the creator. |
| def:batch | appDid | string | no | no | format:did | No description in lexicon yet. |
| def:batch | requestedCutoverAt | string | no | no | format:datetime | No description in lexicon yet. |
money.atmosphere.catalog.createProduct38 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| input | title | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| input | sku | string | no | no | maxLength:64 | No description in lexicon yet. |
| input | kind | string<physical | digital | commission | membership | service | ticket | support | other> | yes | no | maxLength:32 | No description in lexicon yet. |
| input | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| input | price | ref:#priceInput | yes | no | none | No description in lexicon yet. |
| input | inventory | ref:#inventoryInput | no | no | none | No description in lexicon yet. |
| input | variantOf | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| input | appProductRef | ref:#appProductRef | no | no | none | No description in lexicon yet. |
| input | fulfillmentUrl | string | no | no | format:uri | No description in lexicon yet. |
| input | appLabel | string | no | no | maxLength:800, maxGraphemes:80 | No description in lexicon yet. |
| input | appUrl | string | no | no | format:uri | No description in lexicon yet. |
| input | appIconUrl | string | no | no | format:uri | No description in lexicon yet. |
| output | product | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| output | price | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:appProductRef | type | string<shop | commission | membership | membership-tier | custom> | no | no | maxLength:32 | No description in lexicon yet. |
| def:appProductRef | id | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:appProductRef | uri | string | no | no | format:at-uri | No description in lexicon yet. |
| def:appProductRef | cid | string | no | no | format:cid | No description in lexicon yet. |
| def:priceInput | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:priceInput | unitAmount | integer | no | no | minimum:0 | Amount in the smallest currency unit. |
| def:priceInput | type | string<one-time | recurring> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:priceInput | recurring | ref:#recurringInput | no | no | none | No description in lexicon yet. |
| def:priceInput | customUnitAmount | ref:#customUnitAmountInput | no | no | none | No description in lexicon yet. |
| def:priceInput | billingScheme | string<per-unit | tiered> | no | no | maxLength:32 | No description in lexicon yet. |
| def:priceInput | tiersMode | string<graduated | volume> | no | no | maxLength:32 | No description in lexicon yet. |
| def:priceInput | tiers | array<ref:#tierInput> | no | no | maxLength:100 | No description in lexicon yet. |
| def:recurringInput | interval | string<day | week | month | year> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:recurringInput | intervalCount | integer | no | no | minimum:1, maximum:1095 | Number of interval units between billings. |
| def:customUnitAmountInput | enabled | boolean | yes | no | none | No description in lexicon yet. |
| def:customUnitAmountInput | preset | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:customUnitAmountInput | minimum | integer | no | no | minimum:1 | No description in lexicon yet. |
| def:customUnitAmountInput | maximum | integer | no | no | minimum:1 | No description in lexicon yet. |
| def:tierInput | upTo | integer | no | no | minimum:1 | Inclusive upper quantity bound for this tier. |
| def:tierInput | unitAmount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:tierInput | flatAmount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:inventoryInput | trackInventory | boolean | yes | no | none | No description in lexicon yet. |
| def:inventoryInput | quantityTotal | integer | no | no | minimum:0, maximum:1000000 | No description in lexicon yet. |
money.atmosphere.catalog.getProduct34 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | uri | string | yes | no | format:at-uri | No description in lexicon yet. |
| output | product | ref:#catalogProduct | yes | yes | none | No description in lexicon yet. |
| def:catalogPrice | uri | string | yes | no | format:at-uri | No description in lexicon yet. |
| def:catalogPrice | cid | string | yes | no | format:cid | No description in lexicon yet. |
| def:catalogPrice | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:catalogPrice | unitAmount | integer | no | no | minimum:0 | Amount in the smallest currency unit. |
| def:catalogPrice | customUnitAmount | ref:#catalogPriceCustomUnitAmount | no | no | none | No description in lexicon yet. |
| def:catalogPrice | billingScheme | string<per-unit | tiered> | no | no | maxLength:32 | No description in lexicon yet. |
| def:catalogPrice | tiersMode | string<graduated | volume> | no | no | maxLength:32 | No description in lexicon yet. |
| def:catalogPrice | tiers | array<ref:money.atmosphere.price#tier> | no | no | maxLength:100 | No description in lexicon yet. |
| def:catalogPrice | type | string<one-time | recurring> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:catalogPrice | recurring | ref:#catalogPriceRecurring | no | no | none | No description in lexicon yet. |
| def:catalogPrice | archived | boolean | yes | no | none | No description in lexicon yet. |
| def:catalogPrice | createdAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:catalogProduct | uri | string | yes | no | format:at-uri | No description in lexicon yet. |
| def:catalogProduct | cid | string | yes | no | format:cid | No description in lexicon yet. |
| def:catalogProduct | title | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| def:catalogProduct | sku | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:catalogProduct | defaultPrice | ref:#catalogPrice | no | no | none | No description in lexicon yet. |
| def:catalogProduct | kind | string<physical | digital | commission | membership | service | ticket | support | other> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:catalogProduct | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| def:catalogProduct | imageUrl | string | no | no | format:uri | No description in lexicon yet. |
| def:catalogProduct | variantOf | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:catalogProduct | archived | boolean | yes | no | none | No description in lexicon yet. |
| def:catalogProduct | archivedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:catalogProduct | createdAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:catalogProduct | indexedAt | string | yes | no | format:datetime | When the AppView indexed this product. |
| def:catalogProduct | salesCount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:catalogPriceCustomUnitAmount | enabled | boolean | yes | no | none | No description in lexicon yet. |
| def:catalogPriceCustomUnitAmount | preset | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:catalogPriceCustomUnitAmount | minimum | integer | no | no | minimum:1 | No description in lexicon yet. |
| def:catalogPriceCustomUnitAmount | maximum | integer | no | no | minimum:1 | No description in lexicon yet. |
| def:catalogPriceRecurring | interval | string<day | week | month | year> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:catalogPriceRecurring | intervalCount | integer | no | no | minimum:1, maximum:1095 | Absent means 1 (matching Stripe Price.recurring.interval_count). |
money.atmosphere.catalog.listDiscountCodes24 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | creators | array<string> | yes | no | minLength:1, maxLength:50 | No description in lexicon yet. |
| params | includeDisabled | boolean | no | no | none | No description in lexicon yet. |
| params | limit | integer | no | no | minimum:1, maximum:100 | No description in lexicon yet. |
| params | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | codes | array<ref:#catalogDiscountCode> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| def:catalogDiscountCode | uri | string | yes | no | format:at-uri | No description in lexicon yet. |
| def:catalogDiscountCode | cid | string | yes | no | format:cid | No description in lexicon yet. |
| def:catalogDiscountCode | creatorDid | string | yes | no | format:did | The repo DID that authored this discount-code record (the creator). |
| def:catalogDiscountCode | code | string | yes | no | maxLength:64 | No description in lexicon yet. |
| def:catalogDiscountCode | name | string | no | no | maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| def:catalogDiscountCode | discountUri | string | no | no | format:at-uri | No description in lexicon yet. |
| def:catalogDiscountCode | discountCid | string | no | no | format:cid | No description in lexicon yet. |
| def:catalogDiscountCode | percentOffBps | integer | no | no | minimum:1, maximum:10000 | No description in lexicon yet. |
| def:catalogDiscountCode | amountOff | ref:#catalogDiscountAmountOff | no | no | none | No description in lexicon yet. |
| def:catalogDiscountCode | duration | string<once | forever | repeating> | no | no | maxLength:16 | No description in lexicon yet. |
| def:catalogDiscountCode | durationInMonths | integer | no | no | minimum:1, maximum:36 | No description in lexicon yet. |
| def:catalogDiscountCode | maxRedemptions | integer | no | no | minimum:1 | Public configured redemption cap from the record. |
| def:catalogDiscountCode | redeemBy | string | no | no | format:datetime | No description in lexicon yet. |
| def:catalogDiscountCode | disabled | boolean | yes | no | none | Whether the offer is disabled (inverse of the indexed active state). |
| def:catalogDiscountCode | createdAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:catalogDiscountCode | indexedAt | string | no | no | format:datetime | When the AppView indexed this discount code. |
| def:catalogDiscountAmountOff | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:catalogDiscountAmountOff | unitAmount | integer | yes | no | minimum:1 | No description in lexicon yet. |
money.atmosphere.catalog.listProducts41 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | creator | string | yes | no | format:did | No description in lexicon yet. |
| params | includeVariants | boolean | no | no | none | No description in lexicon yet. |
| params | includeArchived | boolean | no | no | none | No description in lexicon yet. |
| params | kind | string<physical | digital | commission | membership | service | ticket | support | other> | no | no | maxLength:32 | No description in lexicon yet. |
| params | withSalesCounts | boolean | no | no | none | No description in lexicon yet. |
| params | limit | integer | no | no | minimum:1, maximum:100 | No description in lexicon yet. |
| params | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | products | array<ref:#catalogProduct> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| def:catalogPrice | uri | string | yes | no | format:at-uri | No description in lexicon yet. |
| def:catalogPrice | cid | string | yes | no | format:cid | No description in lexicon yet. |
| def:catalogPrice | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:catalogPrice | unitAmount | integer | no | no | minimum:0 | Amount in the smallest currency unit. |
| def:catalogPrice | customUnitAmount | ref:#catalogPriceCustomUnitAmount | no | no | none | No description in lexicon yet. |
| def:catalogPrice | billingScheme | string<per-unit | tiered> | no | no | maxLength:32 | No description in lexicon yet. |
| def:catalogPrice | tiersMode | string<graduated | volume> | no | no | maxLength:32 | No description in lexicon yet. |
| def:catalogPrice | tiers | array<ref:money.atmosphere.price#tier> | no | no | maxLength:100 | No description in lexicon yet. |
| def:catalogPrice | type | string<one-time | recurring> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:catalogPrice | recurring | ref:#catalogPriceRecurring | no | no | none | No description in lexicon yet. |
| def:catalogPrice | archived | boolean | yes | no | none | No description in lexicon yet. |
| def:catalogPrice | createdAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:catalogProduct | uri | string | yes | no | format:at-uri | No description in lexicon yet. |
| def:catalogProduct | cid | string | yes | no | format:cid | No description in lexicon yet. |
| def:catalogProduct | title | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| def:catalogProduct | sku | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:catalogProduct | defaultPrice | ref:#catalogPrice | no | no | none | No description in lexicon yet. |
| def:catalogProduct | kind | string<physical | digital | commission | membership | service | ticket | support | other> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:catalogProduct | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| def:catalogProduct | imageUrl | string | no | no | format:uri | No description in lexicon yet. |
| def:catalogProduct | variantOf | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:catalogProduct | archived | boolean | yes | no | none | No description in lexicon yet. |
| def:catalogProduct | archivedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:catalogProduct | createdAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:catalogProduct | indexedAt | string | yes | no | format:datetime | When the AppView indexed this product. |
| def:catalogProduct | salesCount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:catalogPriceCustomUnitAmount | enabled | boolean | yes | no | none | No description in lexicon yet. |
| def:catalogPriceCustomUnitAmount | preset | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:catalogPriceCustomUnitAmount | minimum | integer | no | no | minimum:1 | No description in lexicon yet. |
| def:catalogPriceCustomUnitAmount | maximum | integer | no | no | minimum:1 | No description in lexicon yet. |
| def:catalogPriceRecurring | interval | string<day | week | month | year> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:catalogPriceRecurring | intervalCount | integer | no | no | minimum:1, maximum:1095 | Absent means 1 (matching Stripe Price.recurring.interval_count). |
money.atmosphere.catalog.registerAppLink15 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | creatorDid | string | yes | no | format:did | No description in lexicon yet. |
| input | product | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| input | appProductRef | ref:#appProductRef | no | no | none | No description in lexicon yet. |
| input | fulfillmentUrl | string | no | no | format:uri | No description in lexicon yet. |
| input | appLabel | string | no | no | maxLength:800, maxGraphemes:80 | No description in lexicon yet. |
| input | appUrl | string | no | no | format:uri | No description in lexicon yet. |
| input | appIconUrl | string | no | no | format:uri | No description in lexicon yet. |
| input | environment | string<test | live> | no | no | maxLength:8 | ATM app environment for this private fulfillment link. |
| input | role | string<fulfillment | storefront | analytics> | no | no | maxLength:32 | No description in lexicon yet. |
| input | status | string<active | archived> | no | no | maxLength:32 | No description in lexicon yet. |
| output | ok | boolean | yes | no | none | No description in lexicon yet. |
| def:appProductRef | type | string<shop | commission | membership | membership-tier | custom> | no | no | maxLength:32 | No description in lexicon yet. |
| def:appProductRef | id | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:appProductRef | uri | string | no | no | format:at-uri | No description in lexicon yet. |
| def:appProductRef | cid | string | no | no | format:cid | No description in lexicon yet. |
money.atmosphere.catalog.updateProduct40 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| input | product | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| input | title | string | no | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| input | sku | string | no | no | maxLength:64 | No description in lexicon yet. |
| input | kind | string<physical | digital | commission | membership | service | ticket | support | other> | no | no | maxLength:32 | No description in lexicon yet. |
| input | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| input | price | ref:#priceInput | no | no | none | No description in lexicon yet. |
| input | inventory | ref:#inventoryInput | no | no | none | No description in lexicon yet. |
| input | archived | boolean | no | no | none | Set true to archive the product (removed from new-sale surfaces, still resolvable), false to unarchive. |
| input | appProductRef | ref:#appProductRef | no | no | none | No description in lexicon yet. |
| input | fulfillmentUrl | string | no | no | format:uri | No description in lexicon yet. |
| input | appLabel | string | no | no | maxLength:800, maxGraphemes:80 | No description in lexicon yet. |
| input | appUrl | string | no | no | format:uri | No description in lexicon yet. |
| input | appIconUrl | string | no | no | format:uri | No description in lexicon yet. |
| input | linkStatus | string<active | archived> | no | no | maxLength:32 | No description in lexicon yet. |
| output | product | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| output | price | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:appProductRef | type | string<shop | commission | membership | membership-tier | custom> | no | no | maxLength:32 | No description in lexicon yet. |
| def:appProductRef | id | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:appProductRef | uri | string | no | no | format:at-uri | No description in lexicon yet. |
| def:appProductRef | cid | string | no | no | format:cid | No description in lexicon yet. |
| def:priceInput | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:priceInput | unitAmount | integer | no | no | minimum:0 | Amount in the smallest currency unit. |
| def:priceInput | type | string<one-time | recurring> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:priceInput | recurring | ref:#recurringInput | no | no | none | No description in lexicon yet. |
| def:priceInput | customUnitAmount | ref:#customUnitAmountInput | no | no | none | No description in lexicon yet. |
| def:priceInput | billingScheme | string<per-unit | tiered> | no | no | maxLength:32 | No description in lexicon yet. |
| def:priceInput | tiersMode | string<graduated | volume> | no | no | maxLength:32 | No description in lexicon yet. |
| def:priceInput | tiers | array<ref:#tierInput> | no | no | maxLength:100 | No description in lexicon yet. |
| def:recurringInput | interval | string<day | week | month | year> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:recurringInput | intervalCount | integer | no | no | minimum:1, maximum:1095 | Number of interval units between billings. |
| def:customUnitAmountInput | enabled | boolean | yes | no | none | No description in lexicon yet. |
| def:customUnitAmountInput | preset | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:customUnitAmountInput | minimum | integer | no | no | minimum:1 | No description in lexicon yet. |
| def:customUnitAmountInput | maximum | integer | no | no | minimum:1 | No description in lexicon yet. |
| def:tierInput | upTo | integer | no | no | minimum:1 | Inclusive upper quantity bound for this tier. |
| def:tierInput | unitAmount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:tierInput | flatAmount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:inventoryInput | trackInventory | boolean | yes | no | none | No description in lexicon yet. |
| def:inventoryInput | quantityTotal | integer | no | no | minimum:0, maximum:1000000 | No description in lexicon yet. |
money.atmosphere.discount16 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | name | string | no | no | maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| record | percentOffBps | integer | no | no | minimum:1, maximum:10000 | Percentage discount in basis points. |
| record | amountOff | ref:#amountOff | no | no | none | No description in lexicon yet. |
| record | duration | string<once | forever | repeating> | no | no | maxLength:16 | Stripe-compatible discount duration. |
| record | durationInMonths | integer | no | no | minimum:1 | Required when duration is repeating. |
| record | appliesTo | ref:#appliesTo | no | no | none | No description in lexicon yet. |
| record | maxRedemptions | integer | no | no | minimum:1 | No description in lexicon yet. |
| record | redeemBy | string | no | no | format:datetime | No description in lexicon yet. |
| record | disabled | boolean | no | no | none | No description in lexicon yet. |
| record | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| record | updatedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:amountOff | currency | string | yes | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code. |
| def:amountOff | unitAmount | integer | yes | no | minimum:1 | Amount off in the smallest currency unit. |
| def:appliesTo | productUris | array<string> | no | no | maxLength:200 | ATM product URIs this discount can apply to. |
| def:appliesTo | priceUris | array<string> | no | no | maxLength:200 | ATM price URIs this discount can apply to. |
| def:appliesTo | ticketTierUris | array<string> | no | no | maxLength:200 | Atmosphere Tickets tier URIs this discount can apply to. |
money.atmosphere.discountCode13 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | discount | ref:com.atproto.repo.strongRef | yes | no | none | StrongRef to the money.atmosphere.discount this code redeems. |
| record | code | string | yes | no | maxLength:64 | Customer-facing code. |
| record | name | string | no | no | maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| record | restrictions | ref:#restrictions | no | no | none | No description in lexicon yet. |
| record | maxRedemptions | integer | no | no | minimum:1 | No description in lexicon yet. |
| record | redeemBy | string | no | no | format:datetime | No description in lexicon yet. |
| record | disabled | boolean | no | no | none | No description in lexicon yet. |
| record | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| record | updatedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:restrictions | firstTimeTransaction | boolean | no | no | none | Stripe-compatible first-time transaction restriction. |
| def:restrictions | minimumAmount | ref:#restrictionsMinimumAmount | no | no | none | No description in lexicon yet. |
| def:restrictionsMinimumAmount | currency | string | yes | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code. |
| def:restrictionsMinimumAmount | unitAmount | integer | yes | no | minimum:1 | Minimum payment amount in the smallest currency unit. |
money.atmosphere.event.list11 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | cursor | string | no | no | maxLength:1024 | Opaque pagination cursor from a previous response. |
| params | environment | string<test | live> | no | no | maxLength:8 | No description in lexicon yet. |
| params | limit | integer | no | no | minimum:1, maximum:200 | No description in lexicon yet. |
| output | events | array<ref:#event> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | Opaque cursor to pass back as `cursor` for the next page. |
| def:event | id | string | yes | no | maxLength:128 | Delivery id (the webhook Atm-Delivery-Id). |
| def:event | type | ref:money.atmosphere.event.receive#eventType | yes | no | none | Event type, e.g. |
| def:event | seq | integer | yes | no | minimum:1 | Monotonic sequence position within this app's event stream. |
| def:event | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:event | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| def:event | data | unknown | yes | no | none | The same sanitized event payload the signed webhook carries. |
money.atmosphere.event.receive334 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | id | string | yes | no | maxLength:128 | ATM delivery id. |
| input | type | ref:#eventType | yes | no | none | ATM event type, such as payment.completed or tickets.issued. |
| input | createdAt | string | yes | no | format:datetime | When ATM built the event envelope. |
| input | apiVersion | string | yes | no | maxLength:32 | ATM outbound event envelope version. |
| input | environment | string<test | live> | no | no | maxLength:8 | ATM app environment for this delivery. |
| input | data | union | yes | no | none | Event-specific payload. |
| output | accepted | boolean | no | no | none | Optional acknowledgement. |
| def:payment | id | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:payment | paymentType | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:payment | amount | integer | no | no | none | No description in lexicon yet. |
| def:payment | currency | string | no | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:payment | status | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:payment | payerDid | string | no | no | format:did | No description in lexicon yet. |
| def:payment | recipientDid | string | no | no | format:did | No description in lexicon yet. |
| def:payment | metadata | unknown | no | no | none | Sanitized app-private display context. |
| def:payment | listing | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:payment | entitlements | array<ref:com.atproto.repo.strongRef> | no | no | none | No description in lexicon yet. |
| def:subscriptionChangeOffer | program | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscriptionChangeOffer | tier | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:subscriptionChangeOffer | product | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscriptionChangeOffer | price | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:subscriptionChangeOffer | amount | integer | yes | no | minimum:0 | Recurring amount in the smallest currency unit. |
| def:subscriptionChangeProjection | lifecycleGeneration | integer | yes | no | minimum:1 | Monotonic generation of the processor lifecycle that authored this projection. |
| def:subscriptionChangeProjection | side | string<source | target> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChangeProjection | accessAuthorized | boolean | yes | no | none | No description in lexicon yet. |
| def:subscriptionChangeProjection | state | string<converged | blocked | reconciling> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChangeProjection | authorityInvoiceId | string | yes | no | maxLength:256 | Exact processor invoice whose observed lifecycle authorizes this projection. |
| def:subscriptionChange | id | string | yes | no | maxLength:128 | No description in lexicon yet. |
| def:subscriptionChange | subscriptionId | string | yes | no | maxLength:256 | Durable ATM subscriptions.id relationship key. |
| def:subscriptionChange | environment | string<live | test> | yes | no | maxLength:16 | ATM app environment for this durable relationship change. |
| def:subscriptionChange | status | string<quoted | awaiting_confirmation | awaiting_payment | action_required | scheduled | paid_pending_apply | applied | failed | canceled | superseded | expired> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:subscriptionChange | direction | string<upgrade | downgrade | lateral> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChange | changeRevision | integer | yes | no | minimum:1 | Monotonic revision of this change lifecycle. |
| def:subscriptionChange | subscriptionRevision | integer | yes | no | minimum:1 | Relationship revision the change targets, or the applied relationship revision once effective. |
| def:subscriptionChange | from | ref:#subscriptionChangeOffer | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | to | ref:#subscriptionChangeOffer | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | amountDueNow | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionChange | creditNow | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionChange | nextRecurringAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionChange | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:subscriptionChange | effectiveAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | nextChargeAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | expiresAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | effectiveInvoiceId | string | no | no | maxLength:256 | Exact paid invoice that made this change effective. |
| def:subscriptionChange | failureCode | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:subscriptionChange | projection | ref:#subscriptionChangeProjection | no | no | none | No description in lexicon yet. |
| def:invoice | id | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:invoice | subscriptionId | string | no | no | maxLength:256 | Durable ATM subscriptions.id this invoice belongs to. |
| def:invoice | processorSubscriptionId | string | no | no | maxLength:256 | Processor subscription object id (e.g. |
| def:invoice | amount | integer | no | no | none | Legacy recurring plan amount in the smallest currency unit. |
| def:invoice | amountPaid | integer | no | no | minimum:0 | Actual amount settled for this invoice cycle, in the smallest currency unit. |
| def:invoice | recurringAmount | integer | no | no | minimum:0 | Recurring plan amount associated with the subscription for this cycle, in the smallest currency unit. |
| def:invoice | currency | string | no | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:invoice | paidAt | string | no | no | format:datetime | When the processor marked this invoice cycle paid. |
| def:invoice | firstInvoice | boolean | no | no | none | No description in lexicon yet. |
| def:invoice | change | ref:#subscriptionChange | no | no | none | The applied membership tier change when this exact paid invoice made it effective. |
| def:subscription | id | string | yes | no | maxLength:256 | Durable ATM subscriptions.id. |
| def:subscription | status | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:subscription | processorSubscriptionId | string | no | no | maxLength:256 | Processor subscription object id (e.g. |
| def:subscription | metadata | unknown | no | no | none | Sanitized app-private display context. |
| def:actorSummary | actor | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:actorSummary | did | string | no | no | format:did | No description in lexicon yet. |
| def:ticketHold | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketHold | eventId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:ticketHold | paymentId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:ticketHold | status | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:ticketHold | reason | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:ticketHold | amount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:ticketHold | currency | string | no | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:ticketHold | quantityTotal | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:ticketHold | items | array<ref:#ticketHoldItem> | no | no | none | No description in lexicon yet. |
| def:ticketHoldItem | tierId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketHoldItem | title | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:ticketHoldItem | quantity | integer | no | no | none | No description in lexicon yet. |
| def:ticketHoldItem | unitAmount | integer | no | no | none | No description in lexicon yet. |
| def:ticketHoldItem | currency | string | no | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:restoredDisputeCycle | disputeId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:restoredDisputeCycle | invoiceId | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:restoredDisputeCycle | distributionsReinstated | boolean | yes | no | none | No description in lexicon yet. |
| def:issuedTicket | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | eventId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | tierId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | paymentId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | claimId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | environment | string<test | live> | no | no | maxLength:8 | No description in lexicon yet. |
| def:issuedTicket | ownerDid | string | no | no | format:did | No description in lexicon yet. |
| def:issuedTicket | status | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:issuedTicket | ticketNumber | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | scanToken | string | no | no | maxLength:4000 | No description in lexicon yet. |
| def:issuedTicket | scanUrl | string | no | no | maxLength:2000, format:uri | No description in lexicon yet. |
| def:issuedTicket | createdAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:issuedTicket | updatedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:ticketIssuanceSummary | holdId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketIssuanceSummary | count | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:ticketIssuanceSummary | alreadyIssued | boolean | no | no | none | No description in lexicon yet. |
| def:ticketCheckIn | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketCheckIn | checkInListId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:ticketCheckIn | scannerDid | string | no | no | format:did | No description in lexicon yet. |
| def:ticketCheckIn | checkedInAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:product | uri | string | yes | no | maxLength:1024, format:at-uri | No description in lexicon yet. |
| def:product | cid | string | no | no | format:cid | No description in lexicon yet. |
| def:appProductRef | type | string | no | no | maxLength:32 | No description in lexicon yet. |
| def:appProductRef | id | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:appProductRef | uri | string | no | no | maxLength:1024, format:at-uri | No description in lexicon yet. |
| def:appProductRef | cid | string | no | no | format:cid | No description in lexicon yet. |
| def:productAppLink | productUri | string | yes | no | maxLength:1024, format:at-uri | No description in lexicon yet. |
| def:productAppLink | appDid | string | yes | no | format:did | No description in lexicon yet. |
| def:productAppLink | environment | string<test | live> | no | no | maxLength:8 | No description in lexicon yet. |
| def:productAppLink | appProductRef | ref:#appProductRef | no | no | none | No description in lexicon yet. |
| def:productAppLink | fulfillmentUrl | string | no | no | maxLength:1024, format:uri | No description in lexicon yet. |
| def:productAppLink | label | string | no | no | maxLength:800 | No description in lexicon yet. |
| def:productAppLink | url | string | no | no | maxLength:1024, format:uri | No description in lexicon yet. |
| def:productAppLink | iconUrl | string | no | no | maxLength:1024, format:uri | No description in lexicon yet. |
| def:productAppLink | role | string | no | no | maxLength:32 | No description in lexicon yet. |
| def:productAppLink | status | string | no | no | maxLength:32 | No description in lexicon yet. |
| def:attestation | revision | integer | yes | no | minimum:0 | Monotonic per-payment revision. |
| def:attestation | cid | string | no | no | format:cid | No description in lexicon yet. |
| def:attestation | policy | ref:#attestationPolicy | no | no | none | No description in lexicon yet. |
| def:attestation | disabledReason | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:distribution | planned | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:appWebhookTest | message | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:paymentCompleted | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:paymentCompleted | distribution | ref:#distribution | no | no | none | No description in lexicon yet. |
| def:paymentCompleted | tickets | ref:#ticketIssuanceSummary | no | no | none | No description in lexicon yet. |
| def:paymentCompleted | attestation | ref:#attestation | no | no | none | No description in lexicon yet. |
| def:paymentCompleted | attestationPending | boolean | no | no | none | True when settlement and fulfillment completed while public proof publication remains queued for durable reconciliation. |
| def:paymentFailed | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:paymentFailed | reason | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:paymentRefunded | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:paymentRefunded | invoiceId | string | no | no | maxLength:256 | Exact processor invoice cycle affected when the payment is a reusable subscription relationship. |
| def:paymentRefunded | amount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:paymentRefunded | amountRefundedTotal | integer | no | no | minimum:0 | Cumulative refunded amount for the exact invoice cycle when invoiceId is present; otherwise for the payment, in the smallest currency unit. |
| def:paymentRefunded | partial | boolean | no | no | none | True when the payment is only partially refunded so far. |
| def:paymentRefunded | reason | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:paymentRefunded | distribution | ref:#distribution | no | no | none | No description in lexicon yet. |
| def:paymentRefundUpdated | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:paymentRefundUpdated | invoiceId | string | no | no | maxLength:256 | Exact processor invoice cycle affected when the payment is a reusable subscription relationship. |
| def:paymentRefundUpdated | refundId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:paymentRefundUpdated | status | string<pending | succeeded | failed | canceled | requires-action> | yes | no | maxLength:64 | No description in lexicon yet. |
| def:paymentRefundUpdated | amount | integer | yes | no | minimum:0 | Amount of this refund in the smallest currency unit. |
| def:paymentRefundUpdated | amountRefundedTotal | integer | yes | no | minimum:0 | Cumulative refunded amount for the exact invoice cycle when invoiceId is present; otherwise for the payment, in the smallest currency unit. |
| def:paymentRefundUpdated | partial | boolean | yes | no | none | True when the payment is only partially refunded so far. |
| def:paymentRefundUpdated | applicationFeeRefunded | boolean | yes | no | none | True when the application fee was refunded alongside this refund. |
| def:paymentRefundUpdated | reason | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:paymentDisputed | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:paymentDisputed | invoiceId | string | no | no | maxLength:256 | Exact processor invoice cycle affected when the payment is a reusable subscription relationship. |
| def:paymentDisputed | disputeId | string | no | no | maxLength:256 | Exact processor dispute object for this lifecycle. |
| def:paymentDisputed | reason | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:paymentDisputed | disputeReason | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:paymentDisputed | status | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:paymentDisputed | distribution | ref:#distribution | no | no | none | No description in lexicon yet. |
| def:paymentDisputeClosed | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:paymentDisputeClosed | invoiceId | string | no | no | maxLength:256 | Exact processor invoice cycle affected when the payment is a reusable subscription relationship. |
| def:paymentDisputeClosed | disputeId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:paymentDisputeClosed | outcome | string<won | lost | warning-closed> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:paymentDisputeClosed | status | string | yes | no | maxLength:64 | No description in lexicon yet. |
| def:paymentDisputeClosed | distributionsReinstated | boolean | no | no | none | True when app-share distributions reversed at dispute creation were reinstated after a won dispute. |
| def:paymentDisputeClosed | restoredDisputeCycles | array<ref:#restoredDisputeCycle> | no | no | maxLength:100 | Earlier won cycles whose deferred app-share distributions became restorable when this dispute closed. |
| def:subscriptionInvoicePaid | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:subscriptionInvoicePaid | invoice | ref:#invoice | yes | no | none | No description in lexicon yet. |
| def:subscriptionInvoicePaid | invoiceId | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:subscriptionInvoicePaid | distribution | ref:#distribution | no | no | none | No description in lexicon yet. |
| def:subscriptionInvoicePaid | attestation | ref:#attestation | no | no | none | No description in lexicon yet. |
| def:subscriptionInvoicePaid | attestationPending | boolean | no | no | none | True when the paid invoice completed while public proof publication remains queued for durable reconciliation. |
| def:subscriptionChangeUpdated | change | ref:#subscriptionChange | yes | no | none | No description in lexicon yet. |
| def:subscriptionUpdated | subscription | ref:#subscription | yes | no | none | No description in lexicon yet. |
| def:subscriptionUpdated | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:subscriptionUpdated | previousPayment | ref:#payment | no | no | none | No description in lexicon yet. |
| def:subscriptionUpdated | processorSubscriptionId | string | no | no | maxLength:256 | Processor subscription object id (e.g. |
| def:subscriptionUpdated | priorAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionUpdated | amount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionUpdated | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:subscriptionUpdated | updatedAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionUpdated | currentPeriodEnd | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionUpdated | updatedBy | ref:#actorSummary | no | no | none | No description in lexicon yet. |
| def:subscriptionUpdated | attestation | ref:#attestation | no | no | none | No description in lexicon yet. |
| def:subscriptionCanceled | subscription | ref:#subscription | yes | no | none | No description in lexicon yet. |
| def:subscriptionCanceled | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:subscriptionCanceled | processorSubscriptionId | string | no | no | maxLength:256 | Processor subscription object id (e.g. |
| def:subscriptionCanceled | canceledAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionCanceled | canceledBy | ref:#actorSummary | no | no | none | No description in lexicon yet. |
| def:subscriptionCanceled | reason | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:subscriptionPaymentFailed | subscription | ref:#subscription | yes | no | none | No description in lexicon yet. |
| def:subscriptionPaymentFailed | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:subscriptionPaymentFailed | processorSubscriptionId | string | no | no | maxLength:256 | Processor subscription object id (e.g. |
| def:subscriptionPaymentFailed | invoiceId | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:subscriptionPaymentFailed | reason | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:subscriptionPaymentFailed | hostedInvoiceUrl | string | no | no | maxLength:2000, format:uri | Hosted Stripe invoice URL for the SCA/authentication-required case, so apps can link the buyer to complete 3DS re-authentication. |
| def:subscriptionPaymentFailed | failedAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionRecovered | subscription | ref:#subscription | yes | no | none | No description in lexicon yet. |
| def:subscriptionRecovered | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:subscriptionRecovered | processorSubscriptionId | string | no | no | maxLength:256 | Processor subscription object id (e.g. |
| def:subscriptionRecovered | invoiceId | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:subscriptionRecovered | recoveredAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:pledge | id | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:pledge | recipientDid | string | yes | no | format:did | No description in lexicon yet. |
| def:pledge | payerDid | string | no | no | format:did | Present only for signed-in pledgers; guest pledges omit it. |
| def:pledge | amount | integer | yes | no | minimum:1 | No description in lexicon yet. |
| def:pledge | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:pledge | interval | string<month | quarter | year> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:pledge | tierLabel | string | no | no | maxLength:200 | No description in lexicon yet. |
| def:pledge | subscriptionGroupKey | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:pledge | listing | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:pledge | status | string<pending_setup | active | converting | converted | canceled | superseded | failed | expired> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:pledge | autoConvert | boolean | yes | no | none | No description in lexicon yet. |
| def:pledge | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:pledge | canceledAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:pledge | canceledBy | string<payer | app | creator | admin | system> | no | no | maxLength:16 | No description in lexicon yet. |
| def:pledge | convertedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:pledgeCreated | pledge | ref:#pledge | yes | no | none | No description in lexicon yet. |
| def:pledgeCanceled | pledge | ref:#pledge | yes | no | none | No description in lexicon yet. |
| def:pledgeConverted | pledge | ref:#pledge | yes | no | none | No description in lexicon yet. |
| def:pledgeConverted | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:pledgeConverted | subscriptionId | string | no | no | maxLength:256 | Durable ATM subscriptions.id created by the conversion. |
| def:pledgeConversionFailed | pledge | ref:#pledge | yes | no | none | No description in lexicon yet. |
| def:pledgeConversionFailed | reasonCode | string | yes | no | maxLength:64 | Coarse decline class: card_declined, authentication_required, charge_failed, ... |
| def:pledgeConversionFailed | willRetry | boolean | yes | no | none | True when ATM retries automatically after backoff; false when terminally failed (the app owns re-engagement). |
| def:payerRecordRequested | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:payerRecordRequested | payerDid | string | yes | no | format:did | No description in lexicon yet. |
| def:payerRecordRequested | recipientDid | string | yes | no | format:did | No description in lexicon yet. |
| def:payerRecordRequested | collection | string | yes | no | format:nsid | No description in lexicon yet. |
| def:payerRecordRequested | recordRkey | string | yes | no | minLength:13, maxLength:13 | Exact TID-shaped record key the app must use. |
| def:payerRecordRequested | canonicalRecord | union | yes | no | none | No description in lexicon yet. |
| def:payerRecordRequested | expectedCid | string | yes | no | format:cid | No description in lexicon yet. |
| def:payerRecordRequested | expiresAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:creatorProofRequested | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:creatorProofRequested | creatorDid | string | yes | no | format:did | No description in lexicon yet. |
| def:creatorProofRequested | attestationCid | string | yes | no | format:cid | No description in lexicon yet. |
| def:creatorProofRequested | payerProofRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:creatorProofRequested | proofRecord | ref:network.attested.payment.proof | yes | no | none | No description in lexicon yet. |
| def:creatorProofRequested | expiresAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:payerClaimed | did | string | yes | no | format:did | No description in lexicon yet. |
| def:payerClaimed | paymentIds | array<string> | yes | no | maxLength:200 | No description in lexicon yet. |
| def:payerClaimed | subscriptionIds | array<string> | no | no | maxLength:200 | No description in lexicon yet. |
| def:payerClaimed | ticketIds | array<string> | no | no | maxLength:500 | No description in lexicon yet. |
| def:payerClaimed | claimedAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:attestationUpdated | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:attestationUpdated | proofLifecycleGeneration | integer | no | no | minimum:1 | Monotonic broker-proof lifecycle generation. |
| def:attestationUpdated | proofLifecycleState | string<verified | invalidated> | no | no | maxLength:16 | Broker-proof lifecycle state at proofLifecycleGeneration. |
| def:attestationUpdated | attestationRevision | integer | yes | no | minimum:0 | Monotonic per-payment revision of the state represented by this event. |
| def:attestationUpdated | attestationStatus | string | yes | no | maxLength:64 | Authoritative ATM attestation state at this revision. |
| def:attestationUpdated | trustTier | string<federated | creator-trusted | strict> | yes | yes | maxLength:32 | Active public trust tier, or null when the payment is private or invalidated. |
| def:attestationUpdated | lifecycle | string<active | invalidated> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:attestationUpdated | visibility | string<public | private> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:attestationUpdated | invalidatedAt | string | yes | yes | format:datetime | Authoritative invalidation time, or null while the proof lifecycle is active. |
| def:attestationUpdated | invalidationReason | string | yes | yes | maxLength:128 | Authoritative refund, dispute, or administrative invalidation reason, or null while active. |
| def:attestationUpdated | brokerProofUri | string | yes | yes | format:at-uri | No description in lexicon yet. |
| def:attestationUpdated | brokerProofCid | string | yes | yes | format:cid | No description in lexicon yet. |
| def:attestationUpdated | payerProofUri | string | yes | yes | format:at-uri | No description in lexicon yet. |
| def:attestationUpdated | payerProofCid | string | yes | yes | format:cid | No description in lexicon yet. |
| def:attestationUpdated | payerProofPending | boolean | yes | no | none | No description in lexicon yet. |
| def:attestationUpdated | payerResolvedVia | string<app | broker | declined> | yes | yes | maxLength:16 | No description in lexicon yet. |
| def:attestationUpdated | payerRecordSuppressed | boolean | yes | no | none | No description in lexicon yet. |
| def:attestationUpdated | creatorProofUri | string | yes | yes | format:at-uri | No description in lexicon yet. |
| def:attestationUpdated | creatorProofCid | string | yes | yes | format:cid | No description in lexicon yet. |
| def:attestationUpdated | creatorProofPending | boolean | yes | no | none | No description in lexicon yet. |
| def:attestationUpdated | creatorResolvedVia | string<app | broker | declined> | yes | yes | maxLength:16 | No description in lexicon yet. |
| def:attestationUpdated | payerRecordRetracted | boolean | yes | no | none | True when the payer removed their public payer record. |
| def:attestationUpdated | payerRecordRetractionId | string | yes | yes | maxLength:256 | Stable identifier for this retraction generation. |
| def:productUpdated | product | ref:#product | yes | no | none | No description in lexicon yet. |
| def:productUpdated | creatorDid | string | no | no | format:did | No description in lexicon yet. |
| def:productUpdated | appLink | ref:#productAppLink | no | no | none | No description in lexicon yet. |
| def:productArchived | product | ref:#product | yes | no | none | No description in lexicon yet. |
| def:productArchived | creatorDid | string | no | no | format:did | No description in lexicon yet. |
| def:productArchived | appLink | ref:#productAppLink | no | no | none | No description in lexicon yet. |
| def:productDeleted | product | ref:#product | yes | no | none | No description in lexicon yet. |
| def:productDeleted | creatorDid | string | no | no | format:did | No description in lexicon yet. |
| def:productDeleted | appLink | ref:#productAppLink | no | no | none | No description in lexicon yet. |
| def:ticketHoldCreated | hold | ref:#ticketHold | yes | no | none | No description in lexicon yet. |
| def:ticketHoldExpired | hold | ref:#ticketHold | yes | no | none | No description in lexicon yet. |
| def:ticketsIssued | paymentId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:ticketsIssued | claimId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:ticketsIssued | hold | ref:#ticketHold | yes | no | none | No description in lexicon yet. |
| def:ticketsIssued | tickets | array<ref:#issuedTicket> | yes | no | none | No description in lexicon yet. |
| def:ticketEventCanceled | event | ref:#ticketEventCanceledEvent | yes | no | none | No description in lexicon yet. |
| def:ticketEventCanceled | reason | string | yes | no | maxLength:1000 | No description in lexicon yet. |
| def:ticketEventCanceled | canceledAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:ticketEventCanceled | ticketCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:ticketEventCanceled | paidTicketCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:ticketEventCanceled | freeTicketCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:ticketEventCanceled | refundRequestedCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:ticketEventCanceled | refundPendingCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:ticketEventCanceled | refundNeedsAttentionCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:ticketVoided | paymentId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketVoided | reason | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:ticketVoided | tickets | array<ref:#issuedTicket> | yes | no | none | No description in lexicon yet. |
| def:ticketRefunded | paymentId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketRefunded | reason | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:ticketRefunded | tickets | array<ref:#issuedTicket> | yes | no | none | No description in lexicon yet. |
| def:ticketCheckedIn | ticket | ref:#issuedTicket | yes | no | none | No description in lexicon yet. |
| def:ticketCheckedIn | checkIn | ref:#ticketCheckIn | yes | no | none | No description in lexicon yet. |
| def:ticketFormSubmitted | ticket | ref:#issuedTicket | yes | no | none | No description in lexicon yet. |
| def:ticketFormSubmitted | tierId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketFormSubmitted | submittedAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:ticketFormSubmitted | answeredFieldKeys | array<string> | yes | no | maxLength:30 | Keys of the fields the attendee answered. |
| def:ticketWaitlistJoined | waitlist | ref:#ticketWaitlistJoinedWaitlist | yes | no | none | No description in lexicon yet. |
| def:ticketWaitlistOffered | waitlist | ref:#ticketWaitlistOfferedWaitlist | yes | no | none | No description in lexicon yet. |
| def:ticketCollaborationInvited | collaboration | ref:#ticketCollaboration | yes | no | none | No description in lexicon yet. |
| def:ticketCollaborationAccepted | collaboration | ref:#ticketCollaboration | yes | no | none | No description in lexicon yet. |
| def:ticketCollaborationRevoked | collaboration | ref:#ticketCollaboration | yes | no | none | No description in lexicon yet. |
| def:ticketCollaboration | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketCollaboration | eventId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketCollaboration | primaryOrganizerDid | string | yes | no | format:did | No description in lexicon yet. |
| def:ticketCollaboration | coOrganizerDid | string | yes | no | format:did | No description in lexicon yet. |
| def:ticketCollaboration | status | string<pending | accepted | revoked> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:ticketCollaboration | revenueShareBps | integer | no | no | minimum:0, maximum:10000 | Recorded revenue-share INTENT in basis points, for MANUAL RECONCILIATION ONLY. |
| def:ticketCollaboration | timestamp | string | yes | no | format:datetime | No description in lexicon yet. |
| def:customerSegmentMessageRequested | segmentKey | string<at-risk-churn | high-value | lapsed> | yes | no | maxLength:32 | Which computed cohort the message targets. |
| def:customerSegmentMessageRequested | messageType | string | yes | no | maxLength:64 | App-defined opaque message identifier (e.g. |
| def:customerSegmentMessageRequested | memberCount | integer | yes | no | minimum:0 | Current number of members in the cohort at request time. |
| def:customerSegmentMessageRequested | requestedAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:recipientAuthorizationUpdated | recipientDid | string | yes | no | format:did | No description in lexicon yet. |
| def:recipientAuthorizationUpdated | status | string<approved | blocked | revoked> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:recipientAuthorizationUpdated | approvedPaymentTypes | array<string> | no | no | maxLength:16 | Payment types the recipient approved this app to originate. |
| def:recipientAuthorizationUpdated | approvedFeeShareBps | integer | no | no | minimum:0, maximum:10000 | App fee share approved for this recipient, in basis points. |
| def:recipientAuthorizationUpdated | updatedAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:attestationPolicy | appRecord | string<public | private> | no | no | maxLength:16 | No description in lexicon yet. |
| def:attestationPolicy | attestation | string<public | private> | no | no | maxLength:16 | No description in lexicon yet. |
| def:ticketEventCanceledEvent | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketEventCanceledEvent | title | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketEventCanceledEvent | status | string<canceled> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:ticketEventCanceledEvent | startsAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:ticketWaitlistJoinedWaitlist | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketWaitlistJoinedWaitlist | eventId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketWaitlistJoinedWaitlist | capacityGroupId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketWaitlistJoinedWaitlist | tierId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:ticketWaitlistJoinedWaitlist | quantity | integer | yes | no | minimum:1 | No description in lexicon yet. |
| def:ticketWaitlistOfferedWaitlist | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketWaitlistOfferedWaitlist | eventId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketWaitlistOfferedWaitlist | capacityGroupId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketWaitlistOfferedWaitlist | tierId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:ticketWaitlistOfferedWaitlist | quantity | integer | yes | no | minimum:1 | No description in lexicon yet. |
| def:ticketWaitlistOfferedWaitlist | offerHoldId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketWaitlistOfferedWaitlist | offerExpiresAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.membership.assertMember2 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | memberDid | string | yes | no | format:did | The member DID asserting presence. |
| output | accepted | boolean | yes | no | none | No description in lexicon yet. |
money.atmosphere.membership.createProgram9 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | creatorDid | string | yes | no | format:did | Creator/project DID that will own the membership program. |
| input | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| input | title | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| input | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| input | scope | string<creator-wide | app-specific> | no | no | maxLength:32 | No description in lexicon yet. |
| input | product | ref:com.atproto.repo.strongRef | no | no | none | Optional money.atmosphere.product (kind=membership) in the creator's repo. |
| input | defaultPrice | ref:com.atproto.repo.strongRef | no | no | none | Optional recurring money.atmosphere.price in the creator's repo. |
| input | recipientAssertionJwt | string | no | no | maxLength:8192 | Optional creator presence token (com.atproto.server.getServiceAuth JWT, iss=creatorDid, aud=ATM broker, lxm=money.atmosphere.app.assertRecipient) authorizing this app to author the membership without a standing approval. |
| output | program | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
money.atmosphere.membership.createTier16 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | creatorDid | string | yes | no | format:did | No description in lexicon yet. |
| input | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| input | program | ref:com.atproto.repo.strongRef | yes | no | none | Parent money.atmosphere.membership.program record in the creator's repo. |
| input | title | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| input | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| input | benefits | array<ref:#benefit> | no | no | maxLength:24 | Public benefit labels only; access enforcement comes from payment state. |
| input | product | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| input | price | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| input | unitAmount | integer | no | no | minimum:0 | No description in lexicon yet. |
| input | currency | string | no | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| input | rank | integer | no | no | minimum:0 | No description in lexicon yet. |
| input | sortOrder | integer | no | no | minimum:0 | No description in lexicon yet. |
| input | recipientAssertionJwt | string | no | no | maxLength:8192 | No description in lexicon yet. |
| output | tier | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:benefit | kind | string | no | no | maxLength:80 | No description in lexicon yet. |
| def:benefit | label | string | yes | no | minLength:1, maxLength:1200, maxGraphemes:120 | No description in lexicon yet. |
money.atmosphere.membership.getAccess18 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | memberDid | string | yes | no | format:did | Member DID to check. |
| input | creatorDid | string | yes | no | format:did | Creator or project DID whose membership is being checked. |
| input | memberAssertionJwt | string | yes | no | maxLength:8192 | Single-use, short-TTL member presence token: a com.atproto.server.getServiceAuth JWT with iss = memberDid, aud = the broker DID's #AttestedNetwork service, lxm = money.atmosphere.membership.assertMember. |
| input | environment | string<test | live> | no | no | maxLength:8 | ATM app environment. |
| input | program | string | no | no | format:at-uri | Optional money.atmosphere.membership.program AT-URI to check. |
| input | tier | string | no | no | format:at-uri | Optional money.atmosphere.membership.tier AT-URI to check. |
| input | tierOrAbove | boolean | no | no | none | When true, an exact tier match or a different tier with rank strictly greater than the requested tier rank satisfies access. |
| output | access | boolean | yes | no | none | True when ATM found an active membership satisfying the request. |
| output | memberDid | string | yes | no | format:did | No description in lexicon yet. |
| output | creatorDid | string | yes | no | format:did | No description in lexicon yet. |
| output | program | ref:com.atproto.repo.strongRef | no | no | none | Matched membership program, when resolved. |
| output | tiers | array<ref:#accessTier> | no | no | maxLength:16 | Matched active tiers the caller is authorized to know about. |
| output | checkedAt | string | yes | no | format:datetime | When ATM evaluated access. |
| def:accessTier | tier | ref:com.atproto.repo.strongRef | yes | no | none | Matched money.atmosphere.membership.tier record. |
| def:accessTier | product | ref:com.atproto.repo.strongRef | no | no | none | Linked membership product, when known. |
| def:accessTier | price | ref:com.atproto.repo.strongRef | no | no | none | Linked recurring price, when known. |
| def:accessTier | rank | integer | no | no | minimum:0 | Resolved tier rank, when known. |
| def:accessTier | currentPeriodEndsAt | string | no | no | format:datetime | When the current paid period ends, when available to the caller. |
money.atmosphere.membership.listGrants19 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | creatorDid | string | no | no | format:did | Filter to grants for one creator. |
| params | memberDid | string | no | no | format:did | Filter to grants for one member. |
| params | reference | string | no | no | maxLength:256 | Filter to grants registered with this app-local reference. |
| params | environment | string<test | live> | no | no | maxLength:8 | ATM app environment. |
| params | includeRevoked | boolean | no | no | none | Include revoked grants (tombstones) in the results. |
| params | limit | integer | no | no | minimum:1, maximum:100 | No description in lexicon yet. |
| params | cursor | string | no | no | maxLength:256 | No description in lexicon yet. |
| output | grants | array<ref:#grant> | yes | no | maxLength:100 | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:256 | Opaque pagination cursor; absent on the last page. |
| def:grant | grantId | string | yes | no | maxLength:128 | No description in lexicon yet. |
| def:grant | memberDid | string | yes | no | format:did | No description in lexicon yet. |
| def:grant | creatorDid | string | yes | no | format:did | No description in lexicon yet. |
| def:grant | program | string | no | no | format:at-uri | money.atmosphere.membership.program AT-URI, when the grant is program-scoped. |
| def:grant | tier | string | no | no | format:at-uri | money.atmosphere.membership.tier AT-URI, when the grant is tier-scoped. |
| def:grant | source | string<comp | migration | free_claim> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:grant | registeredAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:grant | expiresAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:grant | revokedAt | string | no | no | format:datetime | Present only when includeRevoked=true returned a revoked grant. |
| def:grant | reference | string | no | no | maxLength:256 | Opaque app-local reconciliation id echoed back. |
money.atmosphere.membership.program10 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | creator | string | yes | no | format:did | DID of the creator or project whose membership this is. |
| record | title | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | Public membership program name. |
| record | description | string | no | no | maxLength:10000, maxGraphemes:1000 | Public description or terms for the membership program. |
| record | scope | string<creator-wide | app-specific> | no | no | maxLength:32 | Whether apps should treat this as a creator-wide membership or a membership intended for one app surface. |
| record | product | ref:com.atproto.repo.strongRef | no | no | none | Optional parent money.atmosphere.product record with kind=membership. |
| record | defaultPrice | ref:com.atproto.repo.strongRef | no | no | none | Optional default recurring money.atmosphere.price for simple support memberships. |
| record | archived | boolean | no | no | none | Whether this membership program is no longer offered to new members. |
| record | archivedAt | string | no | no | format:datetime | No description in lexicon yet. |
| record | createdAt | string | yes | no | format:datetime | When this membership program record was created. |
| record | updatedAt | string | no | no | format:datetime | When this membership program record was last updated. |
money.atmosphere.membership.registerGrant13 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | memberDid | string | yes | no | format:did | Member DID receiving the grant. |
| input | creatorDid | string | yes | no | format:did | Creator or project DID whose membership is being granted. |
| input | program | string | no | no | format:at-uri | Optional money.atmosphere.membership.program AT-URI in the creator's repo. |
| input | tier | string | no | no | format:at-uri | Optional money.atmosphere.membership.tier AT-URI in the creator's repo. |
| input | source | string<comp | migration | free_claim> | yes | no | maxLength:32 | Why the grant exists: a creator comp, a billing-migration import, or a free-tier claim flow. |
| input | environment | string<test | live> | no | no | maxLength:8 | ATM app environment. |
| input | expiresAt | string | no | no | format:datetime | Optional expiry after which the grant no longer satisfies access checks. |
| input | reference | string | no | no | maxLength:256 | Optional opaque app-local reference for reconciliation (for example a migration batch or comp id). |
| output | grantId | string | yes | no | maxLength:128 | Opaque grant id for later revocation. |
| output | memberDid | string | yes | no | format:did | No description in lexicon yet. |
| output | creatorDid | string | yes | no | format:did | No description in lexicon yet. |
| output | registeredAt | string | yes | no | format:datetime | When ATM recorded the grant. |
| output | expiresAt | string | no | no | format:datetime | Echoed expiry, when set. |
money.atmosphere.membership.revokeGrant4 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | grantId | string | yes | no | maxLength:128 | Grant id returned by registerGrant. |
| input | environment | string<test | live> | no | no | maxLength:8 | ATM app environment. |
| output | revoked | boolean | yes | no | none | True when the grant is revoked (including when it was already revoked). |
| output | revokedAt | string | yes | no | format:datetime | When the grant stopped satisfying access checks. |
money.atmosphere.membership.tier17 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | creator | string | yes | no | format:did | DID of the creator or project whose tier this is. |
| record | program | ref:com.atproto.repo.strongRef | yes | no | none | Parent money.atmosphere.membership.program record for this tier. |
| record | title | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | Public tier name. |
| record | description | string | no | no | maxLength:10000, maxGraphemes:1000 | Public description of this tier. |
| record | benefits | array<ref:#benefit> | no | no | maxLength:24 | Public benefit labels only. |
| record | product | ref:com.atproto.repo.strongRef | no | no | none | Optional money.atmosphere.product record with kind=membership for this tier. |
| record | price | ref:com.atproto.repo.strongRef | no | no | none | Optional recurring money.atmosphere.price record for this tier. |
| record | unitAmount | integer | no | no | minimum:0 | Display amount in the smallest unit of currency, matching the linked price when present. |
| record | currency | string | no | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code. |
| record | rank | integer | no | no | minimum:0 | Optional access rank within the program. |
| record | sortOrder | integer | no | no | minimum:0 | Creator-controlled display order. |
| record | archived | boolean | no | no | none | Whether this tier is no longer available for new members. |
| record | archivedAt | string | no | no | format:datetime | No description in lexicon yet. |
| record | createdAt | string | yes | no | format:datetime | When this tier record was created. |
| record | updatedAt | string | no | no | format:datetime | When this tier record was last updated. |
| def:benefit | kind | string | no | no | maxLength:80 | Optional app-neutral benefit category. |
| def:benefit | label | string | yes | no | minLength:1, maxLength:1200, maxGraphemes:120 | Public benefit label. |
money.atmosphere.membership.updateProgram10 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| input | program | ref:com.atproto.repo.strongRef | yes | no | none | The money.atmosphere.membership.program record to update. |
| input | title | string | no | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| input | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| input | scope | string<creator-wide | app-specific> | no | no | maxLength:32 | No description in lexicon yet. |
| input | product | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| input | defaultPrice | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| input | archived | boolean | no | no | none | No description in lexicon yet. |
| input | recipientAssertionJwt | string | no | no | maxLength:8192 | No description in lexicon yet. |
| output | program | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
money.atmosphere.membership.updateTier16 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| input | tier | ref:com.atproto.repo.strongRef | yes | no | none | The money.atmosphere.membership.tier record to update. |
| input | title | string | no | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| input | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| input | benefits | array<ref:#benefit> | no | no | maxLength:24 | No description in lexicon yet. |
| input | product | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| input | price | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| input | unitAmount | integer | no | no | minimum:0 | No description in lexicon yet. |
| input | currency | string | no | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| input | rank | integer | no | no | minimum:0 | No description in lexicon yet. |
| input | sortOrder | integer | no | no | minimum:0 | No description in lexicon yet. |
| input | archived | boolean | no | no | none | No description in lexicon yet. |
| input | recipientAssertionJwt | string | no | no | maxLength:8192 | No description in lexicon yet. |
| output | tier | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:benefit | kind | string | no | no | maxLength:80 | No description in lexicon yet. |
| def:benefit | label | string | yes | no | minLength:1, maxLength:1200, maxGraphemes:120 | No description in lexicon yet. |
money.atmosphere.payment.assertPayer3 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | payerDid | string | yes | no | format:did | The buyer DID asserted by the app-held user session. |
| input | checkoutToken | string | no | no | maxLength:512 | Optional ATM checkout/session token this assertion was minted for. |
| output | accepted | boolean | yes | no | none | No description in lexicon yet. |
money.atmosphere.payment.cancelPledge5 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | pledgeId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| input | reason | string | no | no | maxLength:256 | No description in lexicon yet. |
| output | pledgeId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| output | status | string<canceled> | yes | no | maxLength:32 | Pledge status after cancellation (currently always canceled). |
| output | canceledAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.payment.cancelSubscription7 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | subscriptionId | string | no | no | maxLength:256 | Opaque ATM subscription relationship id from money.atmosphere.payment.listSubscriptions. |
| input | paymentId | string | no | no | maxLength:256 | Legacy/current ATM recurring payment id. |
| input | reason | string | no | no | maxLength:256 | No description in lexicon yet. |
| output | subscriptionId | string | no | no | maxLength:256 | No description in lexicon yet. |
| output | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| output | status | string | yes | no | maxLength:64 | No description in lexicon yet. |
| output | canceledAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.payment.convertPledges10 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | recipientDid | string | yes | no | format:did | No description in lexicon yet. |
| input | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| input | pledgeIds | array<string> | no | no | maxLength:50 | No description in lexicon yet. |
| output | results | array<ref:#result> | yes | no | none | No description in lexicon yet. |
| def:result | pledgeId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:result | outcome | string<converted | superseded | waiting | failed | skipped> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:result | reason | string | no | no | maxLength:500 | Why the pledge is waiting/failed/skipped (e.g. |
| def:result | paymentId | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:result | subscriptionId | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:result | willRetry | boolean | no | no | none | No description in lexicon yet. |
money.atmosphere.payment.createManagementSession7 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | payerDid | string | yes | no | format:did | The payer DID asserted by the app-held user session. |
| input | payerAssertion | string | yes | no | maxLength:4096 | Single-use payer service-auth JWT (lxm money.atmosphere.payment.assertPayer, aud = the broker DID's #AttestedNetwork service, e.g. |
| input | subscriptionId | string | no | no | maxLength:256 | Opaque ATM subscription relationship id from money.atmosphere.payment.listSubscriptions. |
| input | paymentId | string | no | no | maxLength:256 | ATM recurring payment id anchor. |
| input | returnUrl | string | no | no | maxLength:1024, format:uri | Optional link back into the app shown on the management surface. |
| output | url | string | yes | no | format:uri | Short-lived, single-use management session URL. |
| output | expiresAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.payment.createPledge20 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | recipientDid | string | yes | no | format:did | Recipient the payer is pledging to. |
| input | amount | integer | yes | no | minimum:50, maximum:2000000 | Pledged per-cycle amount in integer minor units (same bounds as checkout). |
| input | currency | string | no | no | minLength:3, maxLength:3 | Lowercase ISO 4217. |
| input | interval | string<month | quarter | year> | yes | no | maxLength:16 | No description in lexicon yet. |
| input | environment | string<test | live> | yes | no | maxLength:8 | No description in lexicon yet. |
| input | payerDid | string | no | no | format:did | Optional signed-in payer hint. |
| input | payerEmailHint | string | no | no | maxLength:320 | Private prefill hint for the card-save page. |
| input | tierLabel | string | no | no | maxLength:200 | No description in lexicon yet. |
| input | subscriptionGroupKey | string | no | no | maxLength:256 | Same offering-scoping contract as subscription checkout: pledges and subscriptions sharing a group key are one offering for duplicate blocking. |
| input | listing | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| input | entitlements | array<ref:com.atproto.repo.strongRef> | no | no | maxLength:50 | No description in lexicon yet. |
| input | metadata | unknown | no | no | none | Private app metadata carried onto the converted payment. |
| input | autoConvert | boolean | no | no | none | When true (default) ATM auto-converts after a grace window once the recipient is payable and has approved this app. |
| input | expiresAt | string | no | no | format:datetime | Optional expiry; the pledge is retired without charge if not converted by then. |
| input | returnUrl | string | no | no | maxLength:2048, format:uri | No description in lexicon yet. |
| input | cancelUrl | string | no | no | maxLength:2048, format:uri | No description in lexicon yet. |
| output | pledgeId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| output | token | string | yes | no | maxLength:256 | Browser bearer for the ATM-hosted card-save/manage page. |
| output | url | string | yes | no | maxLength:2048, format:uri | No description in lexicon yet. |
| output | status | string<pending_setup> | yes | no | maxLength:32 | Pledge status right after creation (currently always pending_setup: the payer has not saved a card yet). |
money.atmosphere.payment.createSubscriptionChangeSession39 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | payerDid | string | yes | no | format:did | No description in lexicon yet. |
| input | payerAssertion | string | yes | no | maxLength:4096 | No description in lexicon yet. |
| input | changeId | string | yes | no | maxLength:128 | No description in lexicon yet. |
| input | quoteHash | string | yes | no | minLength:64, maxLength:64 | No description in lexicon yet. |
| input | returnUrl | string | no | no | maxLength:1024, format:uri | No description in lexicon yet. |
| output | change | ref:#subscriptionChange | yes | no | none | No description in lexicon yet. |
| output | url | string | yes | no | format:uri | No description in lexicon yet. |
| output | expiresAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | changeId | string | yes | no | maxLength:128 | Opaque ATM tier-change id. |
| def:subscriptionChange | subscriptionId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:subscriptionChange | subscriptionRevision | integer | yes | no | minimum:1 | No description in lexicon yet. |
| def:subscriptionChange | environment | string<live | test> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChange | status | string<quoted | awaiting_confirmation | awaiting_payment | action_required | scheduled | paid_pending_apply | applied | failed | canceled | superseded | expired> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:subscriptionChange | direction | string<upgrade | downgrade | lateral> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChange | fromPaymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:subscriptionChange | currentProgram | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscriptionChange | currentTier | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscriptionChange | currentListing | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetProgram | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetTier | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetListing | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetEntitlements | array<ref:com.atproto.repo.strongRef> | yes | no | maxLength:50 | No description in lexicon yet. |
| def:subscriptionChange | currentAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionChange | targetAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionChange | chargeAmount | integer | yes | no | minimum:0 | Amount ATM will attempt immediately after exact hosted confirmation. |
| def:subscriptionChange | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:subscriptionChange | interval | string<day | week | month | year> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChange | intervalCount | integer | yes | no | minimum:1, maximum:1095 | No description in lexicon yet. |
| def:subscriptionChange | requiresPayment | boolean | yes | no | none | True when confirmation requires an immediate upgrade payment. |
| def:subscriptionChange | effectiveAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | currentPeriodEnd | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | quoteHash | string | yes | no | minLength:64, maxLength:64 | ATM-authored hash of the exact revision, CIDs, money, cadence, policy, and expiry shown to the payer. |
| def:subscriptionChange | quoteExpiresAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | confirmedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | paidAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | appliedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | failureCode | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:subscriptionChange | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | updatedAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.payment.declineRecord6 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| input | recordType | string<payer | creator> | yes | no | maxLength:16 | No description in lexicon yet. |
| input | reason | string | no | no | maxLength:256 | No description in lexicon yet. |
| output | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| output | recordType | string<payer | creator> | yes | no | maxLength:16 | No description in lexicon yet. |
| output | resolvedVia | string<broker | declined> | yes | no | maxLength:16 | No description in lexicon yet. |
money.atmosphere.payment.diagnoseSubscriptionFailure9 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | subscriptionId | string | yes | no | maxLength:128 | The durable ATM subscription id. |
| params | invoiceId | string | no | no | maxLength:256 | Optional failed-cycle invoice id (informational). |
| output | reason | string<payer-declined | payment-method-expired | authentication-required | processor-unavailable | recipient-account-held | recipient-kyc-pending | unknown> | yes | no | maxLength:32 | No description in lexicon yet. |
| output | recipientHold | boolean | yes | no | none | True when the cause is on the recipient's payout account. |
| output | retryEligible | boolean | yes | no | none | Whether the processor will keep retrying (false for recipient holds). |
| output | recommendedActions | array<string> | yes | no | maxLength:20 | ATM-authored guidance the app acts on (it owns customer comms). |
| output | detail | string | yes | no | maxLength:256 | App-safe summary line; never the raw processor message. |
| output | failedAt | string | no | no | format:datetime | No description in lexicon yet. |
| output | invoiceId | string | no | no | maxLength:256 | No description in lexicon yet. |
money.atmosphere.payment.getSubscriptionChange33 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | changeId | string | yes | no | maxLength:128 | No description in lexicon yet. |
| output | change | ref:#subscriptionChange | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | changeId | string | yes | no | maxLength:128 | Opaque ATM tier-change id. |
| def:subscriptionChange | subscriptionId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:subscriptionChange | subscriptionRevision | integer | yes | no | minimum:1 | No description in lexicon yet. |
| def:subscriptionChange | environment | string<live | test> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChange | status | string<quoted | awaiting_confirmation | awaiting_payment | action_required | scheduled | paid_pending_apply | applied | failed | canceled | superseded | expired> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:subscriptionChange | direction | string<upgrade | downgrade | lateral> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChange | fromPaymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:subscriptionChange | currentProgram | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscriptionChange | currentTier | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscriptionChange | currentListing | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetProgram | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetTier | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetListing | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetEntitlements | array<ref:com.atproto.repo.strongRef> | yes | no | maxLength:50 | No description in lexicon yet. |
| def:subscriptionChange | currentAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionChange | targetAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionChange | chargeAmount | integer | yes | no | minimum:0 | Amount ATM will attempt immediately after exact hosted confirmation. |
| def:subscriptionChange | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:subscriptionChange | interval | string<day | week | month | year> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChange | intervalCount | integer | yes | no | minimum:1, maximum:1095 | No description in lexicon yet. |
| def:subscriptionChange | requiresPayment | boolean | yes | no | none | True when confirmation requires an immediate upgrade payment. |
| def:subscriptionChange | effectiveAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | currentPeriodEnd | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | quoteHash | string | yes | no | minLength:64, maxLength:64 | ATM-authored hash of the exact revision, CIDs, money, cadence, policy, and expiry shown to the payer. |
| def:subscriptionChange | quoteExpiresAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | confirmedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | paidAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | appliedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | failureCode | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:subscriptionChange | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | updatedAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.payment.listPayerProofs7 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | payer | string | yes | no | format:did | DID of the payer whose public payment records to list. |
| params | paymentType | string<network.attested.payment.oneTime | network.attested.payment.recurring | network.attested.payment.scheduled> | no | no | format:nsid | Optional filter by payment collection. |
| params | brokers | array<string> | no | no | maxLength:20 | Optional list of broker DIDs. |
| params | limit | integer | no | no | minimum:1, maximum:100 | No description in lexicon yet. |
| params | cursor | string | no | no | maxLength:1024 | Opaque pagination cursor from a previous response. |
| output | payments | array<union> | yes | no | none | List of the payer's verified public payment records, newest first. |
| output | cursor | string | no | no | maxLength:1024 | Pagination cursor. |
money.atmosphere.payment.listPendingRecords16 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | payerDid | string | no | no | format:did | No description in lexicon yet. |
| params | recipientDid | string | no | no | format:did | No description in lexicon yet. |
| params | recordType | string<payer | creator | any> | no | no | maxLength:16 | No description in lexicon yet. |
| params | limit | integer | no | no | minimum:1, maximum:100 | No description in lexicon yet. |
| params | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | records | array<ref:#record> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| def:record | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:record | recordType | string<payer | creator> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:record | recordRkey | string | yes | no | minLength:13, maxLength:13 | Exact TID-shaped record key the app must use for this publication generation. |
| def:record | payerDid | string | no | no | format:did | No description in lexicon yet. |
| def:record | recipientDid | string | no | no | format:did | No description in lexicon yet. |
| def:record | collection | string | no | no | format:nsid | No description in lexicon yet. |
| def:record | canonicalRecord | union | no | no | none | No description in lexicon yet. |
| def:record | attestationCid | string | no | no | format:cid | No description in lexicon yet. |
| def:record | expectedCid | string | yes | no | format:cid | No description in lexicon yet. |
money.atmosphere.payment.listPledges27 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | environment | string<test | live> | no | no | maxLength:8 | No description in lexicon yet. |
| params | recipientDid | string | no | no | format:did | No description in lexicon yet. |
| params | status | string<pending_setup | active | converting | converted | canceled | superseded | failed | expired | all> | no | no | maxLength:32 | No description in lexicon yet. |
| params | limit | integer | no | no | minimum:1, maximum:100 | No description in lexicon yet. |
| params | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | pledges | array<ref:#pledge> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| def:pledge | id | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:pledge | recipientDid | string | yes | no | format:did | No description in lexicon yet. |
| def:pledge | payerDid | string | no | no | format:did | Present only for signed-in pledgers. |
| def:pledge | amount | integer | yes | no | minimum:1 | No description in lexicon yet. |
| def:pledge | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:pledge | interval | string<month | quarter | year> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:pledge | tierLabel | string | no | no | maxLength:200 | No description in lexicon yet. |
| def:pledge | subscriptionGroupKey | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:pledge | listing | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:pledge | status | string<pending_setup | active | converting | converted | canceled | superseded | failed | expired> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:pledge | statusDetail | string | no | no | maxLength:500 | Coarse machine-readable reason for the current state (e.g. |
| def:pledge | autoConvert | boolean | yes | no | none | No description in lexicon yet. |
| def:pledge | url | string | yes | no | maxLength:2048, format:uri | ATM-hosted card-save/manage page for this pledge. |
| def:pledge | convertedPaymentId | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:pledge | convertedSubscriptionId | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:pledge | convertedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:pledge | canceledAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:pledge | canceledBy | string<payer | app | creator | admin | system> | no | no | maxLength:16 | No description in lexicon yet. |
| def:pledge | expiresAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:pledge | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.payment.listSubscriptions22 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | environment | string<live | test> | no | no | maxLength:16 | No description in lexicon yet. |
| params | status | string<active | all> | no | no | maxLength:16 | No description in lexicon yet. |
| params | limit | integer | no | no | minimum:1, maximum:100 | No description in lexicon yet. |
| params | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | subscriptions | array<ref:#subscription> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| def:subscription | subscriptionId | string | yes | no | maxLength:256 | Opaque ATM subscription relationship id. |
| def:subscription | revision | integer | yes | no | minimum:1 | Monotonic ATM relationship revision. |
| def:subscription | paymentId | string | yes | no | maxLength:256 | Current or initial ATM recurring payment row for this subscription relationship. |
| def:subscription | recipientDid | string | yes | no | format:did | No description in lexicon yet. |
| def:subscription | originatorDid | string | yes | no | format:did | No description in lexicon yet. |
| def:subscription | environment | string<live | test> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscription | amount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscription | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:subscription | interval | string<day | week | month | year> | no | no | maxLength:16 | Billing interval unit, matching money.atmosphere.price#recurring. |
| def:subscription | intervalCount | integer | no | no | minimum:1, maximum:1095 | Number of interval units between billings. |
| def:subscription | status | string<completed | active | trialing | past_due | unpaid | canceled | externally_managed> | yes | no | maxLength:64 | Subscription relationship status. |
| def:subscription | metadata | unknown | no | no | none | Sanitized public display hints only. |
| def:subscription | entitlements | array<ref:com.atproto.repo.strongRef> | no | no | maxLength:50 | No description in lexicon yet. |
| def:subscription | listing | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscription | currentPeriodEnd | string | no | no | format:datetime | End of the currently paid period when known. |
| def:subscription | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.payment.previewSubscriptionChange42 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | payerDid | string | yes | no | format:did | No description in lexicon yet. |
| input | payerAssertion | string | yes | no | maxLength:4096 | No description in lexicon yet. |
| input | environment | string<live | test> | yes | no | maxLength:16 | No description in lexicon yet. |
| input | subscriptionId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| input | expectedRevision | integer | yes | no | minimum:1 | No description in lexicon yet. |
| input | changeAttemptId | string | yes | no | minLength:1, maxLength:200 | App-generated idempotency key. |
| input | targetProgram | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| input | targetTier | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| input | targetPrice | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| input | targetAmount | integer | no | no | minimum:0 | Optional target amount assertion. |
| output | change | ref:#subscriptionChange | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | changeId | string | yes | no | maxLength:128 | Opaque ATM tier-change id. |
| def:subscriptionChange | subscriptionId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:subscriptionChange | subscriptionRevision | integer | yes | no | minimum:1 | No description in lexicon yet. |
| def:subscriptionChange | environment | string<live | test> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChange | status | string<quoted | awaiting_confirmation | awaiting_payment | action_required | scheduled | paid_pending_apply | applied | failed | canceled | superseded | expired> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:subscriptionChange | direction | string<upgrade | downgrade | lateral> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChange | fromPaymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:subscriptionChange | currentProgram | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscriptionChange | currentTier | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscriptionChange | currentListing | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetProgram | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetTier | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetListing | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:subscriptionChange | targetEntitlements | array<ref:com.atproto.repo.strongRef> | yes | no | maxLength:50 | No description in lexicon yet. |
| def:subscriptionChange | currentAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionChange | targetAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionChange | chargeAmount | integer | yes | no | minimum:0 | Amount ATM will attempt immediately after exact hosted confirmation. |
| def:subscriptionChange | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:subscriptionChange | interval | string<day | week | month | year> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:subscriptionChange | intervalCount | integer | yes | no | minimum:1, maximum:1095 | No description in lexicon yet. |
| def:subscriptionChange | requiresPayment | boolean | yes | no | none | True when confirmation requires an immediate upgrade payment. |
| def:subscriptionChange | effectiveAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | currentPeriodEnd | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | quoteHash | string | yes | no | minLength:64, maxLength:64 | ATM-authored hash of the exact revision, CIDs, money, cadence, policy, and expiry shown to the payer. |
| def:subscriptionChange | quoteExpiresAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | confirmedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | paidAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | appliedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | failureCode | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:subscriptionChange | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionChange | updatedAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.payment.refund13 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| input | invoiceId | string | no | no | maxLength:256 | Exact processor invoice cycle to refund for a subscription payment. |
| input | amount | integer | no | no | minimum:1 | Refund amount in the smallest currency unit. |
| input | reasonCode | string<requested-by-customer | duplicate | fraudulent> | no | no | maxLength:32 | Processor-aligned refund reason code. |
| input | reason | string | no | no | maxLength:512 | Optional free-text reason surfaced in refund webhooks and dashboards. |
| input | cancelSubscription | boolean | no | no | none | For subscription payments, also cancel the underlying subscription so it stops billing. |
| input | idempotencyKey | string | no | no | maxLength:256 | Optional caller-supplied idempotency key. |
| output | refundId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| output | invoiceId | string | no | no | maxLength:256 | Exact processor invoice cycle the refund was applied to, when invoice-backed. |
| output | status | string<pending | succeeded | failed | canceled | requires-action> | yes | no | maxLength:64 | Processor refund status at creation time. |
| output | amount | integer | yes | no | minimum:1 | Amount of this refund in the smallest currency unit. |
| output | amountRefundedTotal | integer | yes | no | minimum:0 | Cumulative refunded amount for the exact invoice cycle when invoiceId is present; otherwise for the payment, in the smallest currency unit. |
| output | paymentStatus | string | yes | no | maxLength:64 | No description in lexicon yet. |
money.atmosphere.payment.registerCreatorProof7 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| input | creatorProofUri | string | yes | no | format:at-uri | No description in lexicon yet. |
| input | creatorProofCid | string | yes | no | format:cid | No description in lexicon yet. |
| output | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| output | creatorProofUri | string | yes | no | format:at-uri | No description in lexicon yet. |
| output | creatorProofCid | string | yes | no | format:cid | No description in lexicon yet. |
| output | alreadyRegistered | boolean | no | no | none | No description in lexicon yet. |
money.atmosphere.payment.registerPayerRecord7 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| input | payerRecordUri | string | yes | no | format:at-uri | No description in lexicon yet. |
| input | payerRecordCid | string | yes | no | format:cid | No description in lexicon yet. |
| output | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| output | payerRecordUri | string | yes | no | format:at-uri | No description in lexicon yet. |
| output | payerRecordCid | string | yes | no | format:cid | No description in lexicon yet. |
| output | alreadyRegistered | boolean | no | no | none | No description in lexicon yet. |
money.atmosphere.payment.verifyRecord13 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | paymentUri | string | yes | no | format:at-uri | Exact AT-URI of a network.attested.payment record in its payer-of-record repository. |
| params | paymentCid | string | yes | no | format:cid | Exact record CID paired with paymentUri. |
| params | recipient | string | no | no | format:did | Optional expected recipient DID. |
| output | verified | boolean | yes | no | none | True only when this exact payer record is indexed and backed by ATM's current active broker-proof generation. |
| output | payment | ref:com.atproto.repo.strongRef | no | no | none | The exact verified payment record generation. |
| output | paymentRecord | union | no | no | none | Verbatim public payment record body for CID and attestation-CID verification. |
| output | payer | string | no | no | format:did | Payer-of-record repository DID. |
| output | recipient | string | no | no | format:did | No description in lexicon yet. |
| output | paymentType | string<network.attested.payment.oneTime | network.attested.payment.recurring | network.attested.payment.scheduled> | no | no | format:nsid | No description in lexicon yet. |
| output | attestationCid | string | no | no | format:cid | CID the broker proof attests after attested.network canonicalization. |
| output | broker | string | no | no | format:did | Trusted broker DID that authored brokerProof. |
| output | brokerProof | ref:com.atproto.repo.strongRef | no | no | none | Exact current active network.attested.payment.proof generation. |
| output | brokerProofRecord | ref:network.attested.payment.proof | no | no | none | Verbatim public broker-proof body for independent lifecycle and CID verification. |
money.atmosphere.price23 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | productUri | string | yes | no | format:at-uri | No description in lexicon yet. |
| record | lookupKey | string | no | no | maxLength:200 | No description in lexicon yet. |
| record | nickname | string | no | no | maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| record | currency | string | yes | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code, matching Stripe Price. |
| record | unitAmount | integer | no | no | minimum:0 | Amount in the smallest unit of currency (e.g. |
| record | customUnitAmount | ref:#customUnitAmount | no | no | none | Stripe-compatible customer-chosen amount configuration. |
| record | billingScheme | string<per-unit | tiered> | no | no | maxLength:32 | Stripe-compatible billing scheme. |
| record | tiersMode | string<graduated | volume> | no | no | maxLength:32 | Stripe-compatible tier mode when billingScheme is tiered. |
| record | tiers | array<ref:#tier> | no | no | maxLength:100 | Stripe-compatible quantity or usage tiers for future non-Supper apps. |
| record | type | string<one-time | recurring> | yes | no | maxLength:16 | No description in lexicon yet. |
| record | recurring | ref:#recurring | no | no | none | No description in lexicon yet. |
| record | archived | boolean | no | no | none | No description in lexicon yet. |
| record | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| record | updatedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:tier | upTo | integer | no | no | minimum:1 | Inclusive upper quantity bound for this tier, matching Stripe tiers[].up_to. |
| def:tier | unitAmount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:tier | flatAmount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:customUnitAmount | enabled | boolean | yes | no | none | No description in lexicon yet. |
| def:customUnitAmount | preset | integer | no | no | minimum:0 | Initial amount shown to the buyer, in the smallest unit of currency. |
| def:customUnitAmount | minimum | integer | no | no | minimum:1 | Minimum buyer-entered amount, in the smallest unit of currency. |
| def:customUnitAmount | maximum | integer | no | no | minimum:1 | Maximum buyer-entered amount, in the smallest unit of currency. |
| def:recurring | interval | string<day | week | month | year> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:recurring | intervalCount | integer | no | no | minimum:1, maximum:1095 | Number of interval units between billings (Stripe allows up to 3 years per cycle, e.g. |
money.atmosphere.product13 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | title | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| record | sku | string | no | no | maxLength:64 | No description in lexicon yet. |
| record | defaultPrice | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| record | kind | string<physical | digital | commission | membership | service | ticket | support | other> | yes | no | maxLength:32 | No description in lexicon yet. |
| record | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| record | image | ref:#image | no | no | none | Public product image. |
| record | variantOf | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| record | archived | boolean | no | no | none | No description in lexicon yet. |
| record | archivedAt | string | no | no | format:datetime | No description in lexicon yet. |
| record | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| record | updatedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:image | blob | blob | yes | no | none | No description in lexicon yet. |
| def:image | alt | string | no | no | maxLength:3000, maxGraphemes:300 | No description in lexicon yet. |
money.atmosphere.segments.listMembers11 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | segmentKey | string<at-risk-churn | high-value | lapsed> | yes | no | maxLength:32 | Which computed cohort to list. |
| params | environment | string<test | live> | no | no | maxLength:8 | Which app environment to read. |
| params | limit | integer | no | no | minimum:1, maximum:200 | No description in lexicon yet. |
| params | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | members | array<ref:#member> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| def:member | buyerDid | string | no | no | format:did | Buyer DID. |
| def:member | emailMasked | string | no | no | maxLength:320 | Pre-masked email hint (e.g. |
| def:member | currency | string | no | no | minLength:3, maxLength:3 | Lowercase ISO 4217. |
| def:member | amount | integer | no | no | minimum:0 | Display figure for the cohort (e.g. |
| def:member | computedAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.segments.requestMessage5 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | segmentKey | string<at-risk-churn | high-value | lapsed> | yes | no | maxLength:32 | Which computed cohort to message. |
| input | environment | string<test | live> | no | no | maxLength:8 | Which app environment to target. |
| input | messageType | string | yes | no | maxLength:64 | App-defined opaque message identifier (e.g. |
| output | memberCount | integer | yes | no | minimum:0 | Number of cohort members at request time. |
| output | requestedAt | string | yes | no | format:datetime | No description in lexicon yet. |
attested.network namespace
ATM consumes these schemas as an external spec. Do not publish or extend them from the ATM namespace.
| NSID | Kind | Route | Auth | Status | Summary | Links |
|---|---|---|---|---|---|---|
| network.attested.payment.initiate | procedure | /xrpc/network.attested.payment.initiate | attested.network servicer auth | external spec | Begin a payment flow. | |
| network.attested.payment.lookup | query | /xrpc/network.attested.payment.lookup | Public or app-scoped read | external spec | Look up verified payment records between a payer and a recipient. | |
| network.attested.payment.oneTime | record | PDS | PDS record | external spec | A one-time payment from a supporter to a creator. | |
| network.attested.payment.proof | record | PDS | PDS record | external spec | A remote attestation record stored in the attestor's repository (creator or broker). | |
| network.attested.payment.recurring | record | PDS | PDS record | external spec | A recurring payment commitment. | |
| network.attested.payment.scheduled | record | PDS | PDS record | external spec | A fixed series of payments. | |
| network.attested.payment.status | query | /xrpc/network.attested.payment.status | Public or app-scoped read | external spec | Check the status of a payment initiated via network.attested.payment.initiate. |
attested.network fields
network.attested.payment.initiate3 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | product | string | yes | no | none | Product identifier for the payment being initiated. |
| output | url | string | yes | no | format:uri | URL to direct the payer to in a browser to complete the payment flow (entering payment details, confirming terms, etc). |
| output | token | string | yes | no | none | Opaque token used to poll payment status via network.attested.payment.status. |
network.attested.payment.lookup6 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | payer | string | yes | no | format:did | DID of the payer (supporter). |
| params | brokers | array<string> | no | no | none | Optional list of broker DIDs. |
| params | recipient | string | yes | no | format:did | DID of the recipient (creator). |
| params | paymentType | string<network.attested.payment.oneTime | network.attested.payment.recurring | network.attested.payment.scheduled> | no | no | format:nsid | Optional filter by payment collection. |
| params | entitlements | array<string> | no | no | none | Optional list of entitlement AT-URIs. |
| output | payments | array<union> | yes | no | none | List of verified payment records. |
network.attested.payment.oneTime8 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | memo | string | no | no | maxLength:1024, maxGraphemes:256 | Optional note from the supporter. |
| record | txnid | string | yes | no | maxLength:64 | Unique transaction identifier for deduplication. |
| record | amount | integer | yes | no | minimum:1 | Payment amount in the smallest unit of the given currency (e.g. |
| record | subject | string | yes | no | format:did | DID of the creator receiving payment. |
| record | currency | string | yes | no | minLength:3, maxLength:3 | ISO 4217 currency code (e.g. |
| record | createdAt | string | yes | no | format:datetime | Timestamp of record creation. |
| record | signatures | array<ref:com.atproto.repo.strongRef> | no | no | none | Attestation entries. |
| record | entitlements | array<ref:com.atproto.repo.strongRef> | no | no | none | Optional list of strong references to records representing goods or services the payer is entitled to as a result of this payment. |
network.attested.payment.proof2 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | cid | string | yes | no | format:cid | Attestation CID computed per the badge.blue spec from the payment record, metadata, and repository DID. |
| record | status | string | no | no | none | Optional status indicator for the attestation (implementation-defined). |
network.attested.payment.recurring9 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | unit | string<monthly | quarterly | semiannual | yearly> | yes | no | none | Billing period. |
| record | txnid | string | yes | no | maxLength:64 | Unique transaction identifier for deduplication. |
| record | amount | integer | yes | no | minimum:1 | Amount per billing period in the smallest unit of the given currency. |
| record | subject | string | yes | no | format:did | DID of the creator receiving payment. |
| record | currency | string | yes | no | minLength:3, maxLength:3 | ISO 4217 currency code (e.g. |
| record | createdAt | string | yes | no | format:datetime | Timestamp of initial subscription creation. |
| record | frequency | integer | no | no | minimum:1 | Billing frequency multiplier applied to the unit (e.g. |
| record | signatures | array<ref:com.atproto.repo.strongRef> | no | no | none | Attestation entries. |
| record | entitlements | array<ref:com.atproto.repo.strongRef> | no | no | none | Optional list of strong references to records representing goods or services the payer is entitled to as a result of this payment. |
network.attested.payment.scheduled9 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | unit | string<monthly | quarterly | semiannual | yearly> | yes | no | none | Interval between scheduled payments. |
| record | count | integer | yes | no | minimum:2, maximum:60 | Total number of scheduled payments. |
| record | txnid | string | yes | no | maxLength:64 | Unique transaction identifier for deduplication. |
| record | amount | integer | yes | no | minimum:1 | Amount per payment in the smallest unit of the given currency. |
| record | subject | string | yes | no | format:did | DID of the creator receiving payment. |
| record | currency | string | yes | no | minLength:3, maxLength:3 | ISO 4217 currency code (e.g. |
| record | createdAt | string | yes | no | format:datetime | Timestamp of schedule creation; also the first payment date. |
| record | signatures | array<ref:com.atproto.repo.strongRef> | no | no | none | Attestation entries. |
| record | entitlements | array<ref:com.atproto.repo.strongRef> | no | no | none | Optional list of strong references to records representing goods or services the payer is entitled to as a result of this payment. |
network.attested.payment.status3 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | token | string | yes | no | none | Token returned from network.attested.payment.initiate. |
| output | ref | ref:com.atproto.repo.strongRef | no | no | none | Present when status is 'completed'. |
| output | status | string<pending | completed | failed> | yes | no | none | Current payment status. |
Tickets namespace
Tickets contracts live in the shared local lexicon set so ATM docs can reference ticket payments and app integrations without becoming the consumer-facing event app.
| NSID | Kind | Route | Auth | Status | Summary | Links |
|---|---|---|---|---|---|---|
| tickets.atmosphere.acceptCollaboration | procedure | /xrpc/tickets.atmosphere.acceptCollaboration | Service-auth | beta draft | Accept a pending co-organizer invitation (dual-consent: app service-auth plus the co-organizer's own assertion). | |
| tickets.atmosphere.archiveTicketTier | procedure | /xrpc/tickets.atmosphere.archiveTicketTier | Service-auth | beta draft | Archive an organizer-owned ATM Tickets tier. | |
| tickets.atmosphere.cancelTicketEvent | procedure | /xrpc/tickets.atmosphere.cancelTicketEvent | App service-auth | beta draft | Irreversibly cancel an ATM ticketed event. | |
| tickets.atmosphere.capacityGroup | record | PDS | PDS record | beta draft | Organizer-owned portable capacity group for a ticketed event. | |
| tickets.atmosphere.checkInList | record | PDS | PDS record | beta draft | Public check-in list label for an event. | |
| tickets.atmosphere.checkInTicket | procedure | /xrpc/tickets.atmosphere.checkInTicket | Service-auth | beta draft | Verify and check in a private ATM Tickets scan token. | |
| tickets.atmosphere.claimFreeTicket | procedure | /xrpc/tickets.atmosphere.claimFreeTicket | Service-auth | beta draft | Atomically claim zero-price scarce tickets for a verified buyer without checkout redirect. | |
| tickets.atmosphere.claimWaitlistOffer | procedure | /xrpc/tickets.atmosphere.claimWaitlistOffer | Service-auth | beta draft | Claim a ticket waitlist OFFER by starting checkout against its already-reserved offer hold. | |
| tickets.atmosphere.createCapacityGroup | procedure | /xrpc/tickets.atmosphere.createCapacityGroup | Service-auth | beta draft | Create an organizer-owned capacity group for a ticketed event. | |
| tickets.atmosphere.createTicketEvent | procedure | /xrpc/tickets.atmosphere.createTicketEvent | App service-auth | beta draft | Create or upsert an organizer-owned ATM ticketed-event config shell for a public event. | |
| tickets.atmosphere.createTicketHold | procedure | /xrpc/tickets.atmosphere.createTicketHold | Service-auth | beta draft | Atomically reserve ticket capacity and return an ATM checkout URL. | |
| tickets.atmosphere.createTicketTier | procedure | /xrpc/tickets.atmosphere.createTicketTier | App service-auth | beta draft | Create an organizer-owned ATM Tickets tier and optional public ticket-tier refs for an event. | |
| tickets.atmosphere.defs | defs | /xrpc/tickets.atmosphere.defs | App service-auth | beta draft | No description in lexicon yet. | |
| tickets.atmosphere.getTicketAvailability | query | /xrpc/tickets.atmosphere.getTicketAvailability | Service-auth | beta draft | Read app-scoped ticket availability derived from private ATM holds and issued tickets. | |
| tickets.atmosphere.inviteOrganizerCollaboration | procedure | /xrpc/tickets.atmosphere.inviteOrganizerCollaboration | Service-auth | beta draft | Invite a co-organizer to operationally co-run a ticketed event (Part A: operational delegation only). | |
| tickets.atmosphere.joinWaitlist | procedure | /xrpc/tickets.atmosphere.joinWaitlist | Service-auth | beta draft | Join the FIFO waitlist for a sold-out ticket tier/capacity group. | |
| tickets.atmosphere.listBuyerTickets | query | /xrpc/tickets.atmosphere.listBuyerTickets | Service-auth | beta draft | List app-scoped issued tickets for a buyer or payment. | |
| tickets.atmosphere.listCollaborations | procedure | /xrpc/tickets.atmosphere.listCollaborations | Public or app-scoped read | beta draft | List organizer collaborations for an event (authorized via event control) or the calling co-organizer's own collaboration rows. | |
| tickets.atmosphere.listEventWaitlist | procedure | /xrpc/tickets.atmosphere.listEventWaitlist | Public or app-scoped read | beta draft | List an organizer's event waitlist: a per-capacity-group rollup plus the paginated FIFO queue, each entry with its position and current offer status. | |
| tickets.atmosphere.listOrganizerTickets | query | /xrpc/tickets.atmosphere.listOrganizerTickets | Service-auth | beta draft | List app-scoped issued tickets for an organizer or event. | |
| tickets.atmosphere.listPublicConfig | query | /xrpc/tickets.atmosphere.listPublicConfig | Public or app-scoped read | beta draft | List indexed public tickets.atmosphere ticket config records. | |
| tickets.atmosphere.listTicketFormResponses | procedure | /xrpc/tickets.atmosphere.listTicketFormResponses | Public or app-scoped read | beta draft | List the full private attendee form responses for an organizer's own event. | |
| tickets.atmosphere.publicOffer | record | PDS | PDS record | beta draft | Public offer grouping for event tickets. | |
| tickets.atmosphere.releaseTicketHold | procedure | /xrpc/tickets.atmosphere.releaseTicketHold | Service-auth | beta draft | Release an active ticket hold before checkout completes. | |
| tickets.atmosphere.revokeCollaboration | procedure | /xrpc/tickets.atmosphere.revokeCollaboration | Service-auth | beta draft | Revoke a co-organizer collaboration. | |
| tickets.atmosphere.setTierForm | procedure | /xrpc/tickets.atmosphere.setTierForm | App service-auth | beta draft | Set (or clear) the private per-tier attendee form for a ticketed event. | |
| tickets.atmosphere.ticketTier | record | PDS | PDS record | beta draft | Organizer-owned portable ticket tier metadata for an AT Protocol event. | |
| tickets.atmosphere.updateCapacityGroup | procedure | /xrpc/tickets.atmosphere.updateCapacityGroup | Service-auth | beta draft | Update an organizer-owned capacity group for a ticketed event. | |
| tickets.atmosphere.updateTicketEvent | procedure | /xrpc/tickets.atmosphere.updateTicketEvent | Service-auth | beta draft | Update an app-scoped ATM ticketed-event config shell for a public event. | |
| tickets.atmosphere.updateTicketTier | procedure | /xrpc/tickets.atmosphere.updateTicketTier | Service-auth | beta draft | Update organizer-owned ATM Tickets tier metadata. | |
| tickets.atmosphere.verifyTicket | procedure | /xrpc/tickets.atmosphere.verifyTicket | Service-auth | beta draft | Verify a private ATM Tickets scan token without mutating check-in state. |
Tickets fields
tickets.atmosphere.acceptCollaboration5 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | collaborationId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | coOrganizerDid | string | yes | no | format:did | The accepting co-organizer. |
| input | coOrganizerAssertionJwt | string | yes | no | maxLength:8192 | REQUIRED short-lived user service-auth JWT issued BY coOrganizerDid to ATM, scoped to tickets.atmosphere.acceptCollaboration. |
| output | collaboration | ref:tickets.atmosphere.defs#organizerCollaboration | yes | no | none | No description in lexicon yet. |
tickets.atmosphere.archiveTicketTier5 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | tierId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| output | tier | ref:#tier | yes | no | none | No description in lexicon yet. |
| def:tier | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:tier | status | string<archived> | yes | no | maxLength:32 | No description in lexicon yet. |
tickets.atmosphere.cancelTicketEvent11 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | eventId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | reason | string | yes | no | minLength:3, maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| output | cancellation | ref:#cancellation | yes | no | none | No description in lexicon yet. |
| def:cancellation | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:cancellation | eventId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:cancellation | status | string<requested | already-canceled> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:cancellation | ticketCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:cancellation | paidTicketCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:cancellation | freeTicketCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:cancellation | releasedHoldCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
tickets.atmosphere.capacityGroup6 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | event | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| record | name | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| record | totalCapacity | integer | no | no | minimum:1, maximum:250000 | Organizer-configured capacity ceiling for this shared inventory pool. |
| record | archived | boolean | no | no | none | No description in lexicon yet. |
| record | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| record | updatedAt | string | no | no | format:datetime | No description in lexicon yet. |
tickets.atmosphere.checkInList5 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | event | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| record | name | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| record | archived | boolean | no | no | none | No description in lexicon yet. |
| record | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| record | updatedAt | string | no | no | format:datetime | No description in lexicon yet. |
tickets.atmosphere.checkInTicket8 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | ticketToken | string | yes | no | minLength:1, maxLength:4000 | No description in lexicon yet. |
| input | checkInListId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | scannerDid | string | no | no | format:did | App-asserted staff DID recorded in the private check-in audit log. |
| input | metadata | unknown | no | no | none | No description in lexicon yet. |
| output | status | string<checked-in | already-checked-in | not-valid> | yes | no | maxLength:32 | No description in lexicon yet. |
| output | checkedInAt | string | no | no | format:datetime | No description in lexicon yet. |
| output | ticket | ref:tickets.atmosphere.defs#issuedTicket | no | no | none | No description in lexicon yet. |
tickets.atmosphere.claimFreeTicket15 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | eventId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | eventUri | string | no | no | format:at-uri | No description in lexicon yet. |
| input | buyerDid | string | yes | no | format:did | No description in lexicon yet. |
| input | buyerAssertionJwt | string | yes | no | maxLength:8192 | Required short-lived user service-auth JWT from buyerDid to ATM, scoped to tickets.atmosphere.claimFreeTicket. |
| input | customerEmail | string | no | no | maxLength:320 | Private delivery/receipt hint for ticket emails. |
| input | items | array<ref:tickets.atmosphere.defs#ticketHoldItemRequest> | yes | no | minLength:1, maxLength:20 | No description in lexicon yet. |
| input | idempotencyKey | string | no | no | minLength:1, maxLength:200 | No description in lexicon yet. |
| input | metadata | unknown | no | no | none | No description in lexicon yet. |
| output | claimId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| output | holdId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| output | environment | string<test | live> | yes | no | maxLength:16 | No description in lexicon yet. |
| output | items | array<ref:tickets.atmosphere.defs#ticketHoldItem> | yes | no | minLength:1, maxLength:20 | No description in lexicon yet. |
| output | tickets | array<ref:tickets.atmosphere.defs#issuedTicketWithContext> | yes | no | minLength:1, maxLength:1000 | No description in lexicon yet. |
| output | reused | boolean | no | no | none | No description in lexicon yet. |
tickets.atmosphere.claimWaitlistOffer15 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | waitlistId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | buyerDid | string | no | no | format:did | No description in lexicon yet. |
| input | buyerAssertionJwt | string | no | no | maxLength:8192 | Optional short-lived user service-auth JWT from buyerDid to ATM, scoped to tickets.atmosphere.claimWaitlistOffer. |
| input | customerEmail | string | no | no | maxLength:320 | Private delivery/receipt hint. |
| input | returnUrl | string | no | no | maxLength:2000, format:uri | No description in lexicon yet. |
| input | cancelUrl | string | no | no | maxLength:2000, format:uri | No description in lexicon yet. |
| output | waitlistId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| output | holdId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| output | token | string | yes | no | maxLength:500 | No description in lexicon yet. |
| output | url | string | yes | no | maxLength:2000, format:uri | No description in lexicon yet. |
| output | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| output | expiresAt | string | yes | no | format:datetime | No description in lexicon yet. |
| output | amount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| output | currency | string | yes | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code, matching money.atmosphere.price. |
tickets.atmosphere.createCapacityGroup9 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | organizerDid | string | yes | no | format:did | No description in lexicon yet. |
| input | organizerAssertionJwt | string | no | no | maxLength:8192 | Optional short-lived user service-auth JWT from organizerDid to ATM, scoped to tickets.atmosphere.createCapacityGroup. |
| input | event | ref:tickets.atmosphere.defs#eventInput | yes | no | none | No description in lexicon yet. |
| input | name | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| input | totalCapacity | integer | yes | no | minimum:1, maximum:250000 | No description in lexicon yet. |
| input | metadata | unknown | no | no | none | No description in lexicon yet. |
| output | event | ref:tickets.atmosphere.defs#eventSummary | yes | no | none | No description in lexicon yet. |
| output | capacityGroup | ref:tickets.atmosphere.defs#capacityGroupSummary | yes | no | none | No description in lexicon yet. |
tickets.atmosphere.createTicketEvent7 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | organizerDid | string | yes | no | format:did | No description in lexicon yet. |
| input | organizerAssertionJwt | string | no | no | maxLength:8192 | Optional short-lived user service-auth JWT from organizerDid to ATM, scoped to tickets.atmosphere.createTicketEvent. |
| input | event | ref:tickets.atmosphere.defs#eventInput | yes | no | none | No description in lexicon yet. |
| input | status | string<active | paused | archived> | no | no | maxLength:32 | ATM ticket-sales lifecycle state. |
| input | metadata | unknown | no | no | none | No description in lexicon yet. |
| output | event | ref:tickets.atmosphere.defs#eventSummary | yes | no | none | No description in lexicon yet. |
tickets.atmosphere.createTicketHold21 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | eventId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | eventUri | string | no | no | format:at-uri | No description in lexicon yet. |
| input | buyerDid | string | no | no | format:did | Signed-in buyer DID. |
| input | buyerAssertionJwt | string | no | no | maxLength:8192 | Short-lived user service-auth JWT from buyerDid to ATM, scoped to lxm money.atmosphere.payment.assertPayer. |
| input | customerEmail | string | no | no | maxLength:320 | Private delivery/receipt hint for ticket emails. |
| input | offerCode | string | no | no | minLength:3, maxLength:64 | Optional organizer offer code. |
| input | items | array<ref:tickets.atmosphere.defs#ticketHoldItemRequest> | yes | no | minLength:1, maxLength:20 | No description in lexicon yet. |
| input | returnUrl | string | no | no | maxLength:2000, format:uri | No description in lexicon yet. |
| input | cancelUrl | string | no | no | maxLength:2000, format:uri | No description in lexicon yet. |
| input | idempotencyKey | string | no | no | minLength:1, maxLength:200 | No description in lexicon yet. |
| input | metadata | unknown | no | no | none | No description in lexicon yet. |
| output | holdId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| output | token | string | yes | no | maxLength:500 | No description in lexicon yet. |
| output | url | string | yes | no | maxLength:2000, format:uri | No description in lexicon yet. |
| output | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| output | expiresAt | string | yes | no | format:datetime | No description in lexicon yet. |
| output | amount | integer | yes | no | minimum:0 | Final buyer checkout amount in minor units after any order-level offer and passed-through ATM ticket fee. |
| output | currency | string | yes | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code, matching money.atmosphere.price. |
| output | items | array<ref:tickets.atmosphere.defs#ticketHoldItem> | yes | no | minLength:1, maxLength:20 | No description in lexicon yet. |
| output | reused | boolean | no | no | none | No description in lexicon yet. |
tickets.atmosphere.createTicketTier19 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | organizerDid | string | yes | no | format:did | No description in lexicon yet. |
| input | organizerAssertionJwt | string | no | no | maxLength:8192 | Optional short-lived user service-auth JWT from organizerDid to ATM, scoped to tickets.atmosphere.createTicketTier. |
| input | event | ref:tickets.atmosphere.defs#eventInput | yes | no | none | No description in lexicon yet. |
| input | title | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| input | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| input | currency | string | yes | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code, matching money.atmosphere.price. |
| input | unitAmount | integer | yes | no | minimum:0, maximum:2000000 | Amount in the smallest unit of currency. |
| input | maxPerOrder | integer | no | no | minimum:1, maximum:50 | No description in lexicon yet. |
| input | saleStartsAt | string | no | no | format:datetime | No description in lexicon yet. |
| input | saleEndsAt | string | no | no | format:datetime | No description in lexicon yet. |
| input | tierRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| input | productRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| input | priceRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| input | metadata | unknown | no | no | none | No description in lexicon yet. |
| input | quantityTotal | integer | yes | no | minimum:1, maximum:250000 | No description in lexicon yet. |
| output | event | ref:tickets.atmosphere.defs#eventSummary | yes | no | none | No description in lexicon yet. |
| output | capacityGroup | ref:tickets.atmosphere.defs#capacityGroupSummary | yes | no | none | No description in lexicon yet. |
| output | tier | ref:tickets.atmosphere.defs#ticketTierSummary | yes | no | none | No description in lexicon yet. |
tickets.atmosphere.defs113 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| def:eventInput | uri | string | yes | no | format:at-uri | No description in lexicon yet. |
| def:eventInput | cid | string | no | no | format:cid | No description in lexicon yet. |
| def:eventInput | title | string | yes | no | minLength:1, maxLength:3000, maxGraphemes:300 | No description in lexicon yet. |
| def:eventInput | startsAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:eventInput | imageUrl | string | no | no | maxLength:2000, format:uri | No description in lexicon yet. |
| def:ticketHoldItemRequest | tierId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| def:ticketHoldItemRequest | quantity | integer | yes | no | minimum:1, maximum:50 | No description in lexicon yet. |
| def:ticketHoldItem | tierId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketHoldItem | title | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketHoldItem | quantity | integer | yes | no | minimum:1, maximum:50 | No description in lexicon yet. |
| def:ticketHoldItem | unitAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:ticketHoldItem | currency | string | yes | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code, matching money.atmosphere.price. |
| def:ticketHoldItem | tierRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:ticketHoldItem | productRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:ticketHoldItem | priceRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:ticketTierSummary | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketTierSummary | eventId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketTierSummary | capacityGroupId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketTierSummary | title | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketTierSummary | currency | string | yes | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code, matching money.atmosphere.price. |
| def:ticketTierSummary | unitAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:ticketTierSummary | status | string<active | paused | archived> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:ticketTierSummary | tierRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:ticketTierSummary | productRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:ticketTierSummary | priceRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:capacityGroupSummary | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:capacityGroupSummary | eventId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:capacityGroupSummary | name | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:capacityGroupSummary | totalCapacity | integer | yes | no | minimum:1 | No description in lexicon yet. |
| def:capacityGroupSummary | status | string<active | archived> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:eventSummary | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:eventSummary | uri | string | yes | no | format:at-uri | No description in lexicon yet. |
| def:eventSummary | cid | string | no | no | format:cid | No description in lexicon yet. |
| def:eventSummary | eventRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:eventSummary | title | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:eventSummary | startsAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:organizerCollaboration | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:organizerCollaboration | eventId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:organizerCollaboration | primaryOrganizerDid | string | yes | no | format:did | No description in lexicon yet. |
| def:organizerCollaboration | coOrganizerDid | string | yes | no | format:did | No description in lexicon yet. |
| def:organizerCollaboration | role | string<co-organizer> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:organizerCollaboration | status | string<pending | accepted | revoked> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:organizerCollaboration | revenueShareBps | integer | no | no | minimum:0, maximum:10000 | Recorded revenue-share INTENT in basis points, for MANUAL RECONCILIATION ONLY. |
| def:organizerCollaboration | invitedAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:organizerCollaboration | acceptedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:organizerCollaboration | revokedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:ticketAvailability | tierId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketAvailability | eventId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:ticketAvailability | title | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketAvailability | description | string | no | no | maxLength:5000 | No description in lexicon yet. |
| def:ticketAvailability | currency | string | no | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code, matching money.atmosphere.price. |
| def:ticketAvailability | unitAmount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:ticketAvailability | status | string<available | sold-out | not-on-sale | hidden | unavailable> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:ticketAvailability | availableQuantity | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:ticketAvailability | heldQuantity | integer | no | no | minimum:0 | Quantity currently reserved by active holds. |
| def:ticketAvailability | soldQuantity | integer | no | no | minimum:0 | Quantity already issued/sold. |
| def:ticketAvailability | maxPerOrder | integer | yes | no | minimum:1, maximum:50 | No description in lexicon yet. |
| def:ticketAvailability | saleStartsAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:ticketAvailability | saleEndsAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:ticketPresentation | iconUrl | string | no | no | maxLength:2000, format:uri | Pass icon URL. |
| def:ticketPresentation | qr | ref:#ticketPresentationQr | yes | no | none | No description in lexicon yet. |
| def:ticketPresentation | app | ref:tickets.atmosphere.defs#brand | yes | no | none | No description in lexicon yet. |
| def:ticketPresentation | organizer | ref:tickets.atmosphere.defs#brand | yes | no | none | No description in lexicon yet. |
| def:ticketPresentation | event | ref:#ticketPresentationEvent | yes | no | none | No description in lexicon yet. |
| def:ticketPresentation | tier | ref:#ticketPresentationTier | yes | no | none | No description in lexicon yet. |
| def:brand | did | string | yes | no | format:did | No description in lexicon yet. |
| def:brand | handle | string | no | no | format:handle | No description in lexicon yet. |
| def:brand | name | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:brand | avatarUrl | string | no | no | maxLength:2000, format:uri | No description in lexicon yet. |
| def:issuedTicket | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | eventId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | tierId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | paymentId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | claimId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | environment | string<test | live> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:issuedTicket | ownerDid | string | no | no | format:did | No description in lexicon yet. |
| def:issuedTicket | status | string<active | voided | refunded> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:issuedTicket | ticketNumber | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicket | eventRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:issuedTicket | tierRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:issuedTicket | productRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:issuedTicket | priceRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:issuedTicket | scanToken | string | no | no | maxLength:4000 | Private scan token returned only to authorized clients. |
| def:issuedTicket | scanUrl | string | no | no | maxLength:2000, format:uri | No description in lexicon yet. |
| def:issuedTicket | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:issuedTicket | updatedAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:issuedTicketWithContext | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicketWithContext | eventId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicketWithContext | tierId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicketWithContext | paymentId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicketWithContext | claimId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicketWithContext | environment | string<test | live> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:issuedTicketWithContext | ownerDid | string | no | no | format:did | No description in lexicon yet. |
| def:issuedTicketWithContext | status | string<active | voided | refunded> | yes | no | maxLength:32 | No description in lexicon yet. |
| def:issuedTicketWithContext | ticketNumber | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:issuedTicketWithContext | eventRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:issuedTicketWithContext | tierRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:issuedTicketWithContext | productRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:issuedTicketWithContext | priceRef | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:issuedTicketWithContext | scanToken | string | no | no | maxLength:4000 | No description in lexicon yet. |
| def:issuedTicketWithContext | scanUrl | string | no | no | maxLength:2000, format:uri | No description in lexicon yet. |
| def:issuedTicketWithContext | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:issuedTicketWithContext | updatedAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:issuedTicketWithContext | presentation | ref:tickets.atmosphere.defs#ticketPresentation | no | no | none | No description in lexicon yet. |
| def:issuedTicketWithContext | event | ref:tickets.atmosphere.defs#eventSummary | no | no | none | No description in lexicon yet. |
| def:issuedTicketWithContext | tier | ref:tickets.atmosphere.defs#ticketTierSummary | no | no | none | No description in lexicon yet. |
| def:ticketPresentationQr | enabled | boolean | yes | no | none | No description in lexicon yet. |
| def:ticketPresentationQr | label | string | yes | no | maxLength:100 | No description in lexicon yet. |
| def:ticketPresentationEvent | uri | string | yes | no | format:at-uri | No description in lexicon yet. |
| def:ticketPresentationEvent | title | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketPresentationEvent | startsAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:ticketPresentationEvent | imageUrl | string | no | no | maxLength:2000, format:uri | No description in lexicon yet. |
| def:ticketPresentationTier | title | string | yes | no | maxLength:300 | No description in lexicon yet. |
tickets.atmosphere.getTicketAvailability5 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| params | eventId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| params | eventUri | string | no | no | format:at-uri | No description in lexicon yet. |
| output | event | ref:tickets.atmosphere.defs#eventSummary | no | no | none | No description in lexicon yet. |
| output | tiers | array<ref:tickets.atmosphere.defs#ticketAvailability> | yes | no | maxLength:250 | No description in lexicon yet. |
tickets.atmosphere.inviteOrganizerCollaboration8 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | eventId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | eventUri | string | no | no | format:at-uri | No description in lexicon yet. |
| input | organizerDid | string | yes | no | format:did | The inviting PRIMARY organizer (or an already-accepted co-organizer) authorizing this invite. |
| input | organizerAssertionJwt | string | no | no | maxLength:8192 | Optional short-lived user service-auth JWT from organizerDid to ATM, scoped to tickets.atmosphere.inviteOrganizerCollaboration. |
| input | coOrganizerDid | string | yes | no | format:did | The DID being invited to co-organize the event. |
| input | revenueShareBps | integer | no | no | minimum:0, maximum:10000 | OPTIONAL recorded revenue-share INTENT in basis points (0..10000), for MANUAL RECONCILIATION ONLY between the primary organizer and the co-organizer. |
| output | collaboration | ref:tickets.atmosphere.defs#organizerCollaboration | yes | no | none | No description in lexicon yet. |
tickets.atmosphere.joinWaitlist15 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | eventId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | eventUri | string | no | no | format:at-uri | No description in lexicon yet. |
| input | tierId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | buyerDid | string | no | no | format:did | No description in lexicon yet. |
| input | buyerAssertionJwt | string | no | no | maxLength:8192 | Optional short-lived user service-auth JWT from buyerDid to ATM, scoped to tickets.atmosphere.joinWaitlist. |
| input | customerEmail | string | no | no | maxLength:320 | Private delivery hint for the offer email. |
| input | quantity | integer | no | no | minimum:1, maximum:50 | No description in lexicon yet. |
| output | waitlistId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| output | status | string<waiting | offered | claimed | expired | released> | yes | no | maxLength:16 | No description in lexicon yet. |
| output | position | integer | yes | no | minimum:0 | No description in lexicon yet. |
| output | quantity | integer | yes | no | minimum:1 | No description in lexicon yet. |
| output | eventId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| output | capacityGroupId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| output | reused | boolean | no | no | none | No description in lexicon yet. |
tickets.atmosphere.listBuyerTickets7 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| params | buyerDid | string | no | no | format:did | No description in lexicon yet. |
| params | paymentId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| params | limit | integer | no | no | minimum:1, maximum:100 | No description in lexicon yet. |
| params | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | tickets | array<ref:tickets.atmosphere.defs#issuedTicketWithContext> | yes | no | maxLength:100 | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
tickets.atmosphere.listCollaborations10 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | eventId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | organizerDid | string | no | no | format:did | When listing an event's collaborations, the requesting organizer (verified via event control). |
| input | organizerAssertionJwt | string | no | no | maxLength:8192 | No description in lexicon yet. |
| input | coOrganizerDid | string | no | no | format:did | When listing a co-organizer's OWN collaborations, their DID (verified via coOrganizerAssertionJwt). |
| input | coOrganizerAssertionJwt | string | no | no | maxLength:8192 | No description in lexicon yet. |
| input | limit | integer | no | no | minimum:1, maximum:250 | No description in lexicon yet. |
| input | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | collaborations | array<ref:tickets.atmosphere.defs#organizerCollaboration> | yes | no | maxLength:250 | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
tickets.atmosphere.listEventWaitlist30 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | eventId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | organizerDid | string | yes | no | format:did | No description in lexicon yet. |
| input | organizerAssertionJwt | string | no | no | maxLength:8192 | No description in lexicon yet. |
| input | capacityGroupId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | includeTerminal | boolean | no | no | none | Include terminal (claimed/expired/released) rows in the queue page. |
| input | limit | integer | no | no | minimum:1, maximum:250 | No description in lexicon yet. |
| input | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | summaries | array<ref:#waitlistSummary> | yes | no | maxLength:1000 | No description in lexicon yet. |
| output | entries | array<ref:#waitlistEntry> | yes | no | maxLength:250 | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| def:waitlistSummary | eventId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:waitlistSummary | capacityGroupId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:waitlistSummary | capacityGroupName | string | yes | no | maxLength:200 | No description in lexicon yet. |
| def:waitlistSummary | activeCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:waitlistSummary | waitingCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:waitlistSummary | offeredCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:waitlistSummary | activeQuantity | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:waitlistEntry | waitlistId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:waitlistEntry | eventId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:waitlistEntry | capacityGroupId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:waitlistEntry | position | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:waitlistEntry | quantity | integer | yes | no | minimum:1 | No description in lexicon yet. |
| def:waitlistEntry | status | string<waiting | offered | claimed | expired | released> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:waitlistEntry | buyerDid | string | no | no | format:did | No description in lexicon yet. |
| def:waitlistEntry | customerEmailHint | string | no | no | maxLength:200 | No description in lexicon yet. |
| def:waitlistEntry | offerHoldId | string | no | no | maxLength:300 | No description in lexicon yet. |
| def:waitlistEntry | offeredAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:waitlistEntry | offerExpiresAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:waitlistEntry | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
tickets.atmosphere.listOrganizerTickets7 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| params | organizerDid | string | no | no | format:did | No description in lexicon yet. |
| params | eventId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| params | limit | integer | no | no | minimum:1, maximum:250 | No description in lexicon yet. |
| params | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | tickets | array<ref:tickets.atmosphere.defs#issuedTicketWithContext> | yes | no | maxLength:250 | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
tickets.atmosphere.listPublicConfig32 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| params | organizer | string | no | no | format:did | No description in lexicon yet. |
| params | eventUri | string | no | no | format:at-uri | No description in lexicon yet. |
| params | collections | array<string<tickets.atmosphere.ticketTier | tickets.atmosphere.capacityGroup | tickets.atmosphere.publicOffer>> | no | no | maxLength:3 | No description in lexicon yet. |
| params | includeArchived | boolean | no | no | none | No description in lexicon yet. |
| params | limit | integer | no | no | minimum:1, maximum:100 | No description in lexicon yet. |
| params | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | records | array<ref:#publicConfigRecord> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| def:publicConfigRecord | uri | string | yes | no | format:at-uri | No description in lexicon yet. |
| def:publicConfigRecord | cid | string | yes | no | format:cid | No description in lexicon yet. |
| def:publicConfigRecord | organizer | string | yes | no | format:did | No description in lexicon yet. |
| def:publicConfigRecord | collection | string<tickets.atmosphere.ticketTier | tickets.atmosphere.capacityGroup | tickets.atmosphere.publicOffer> | yes | no | maxLength:64 | No description in lexicon yet. |
| def:publicConfigRecord | rkey | string | yes | no | maxLength:512 | No description in lexicon yet. |
| def:publicConfigRecord | event | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| def:publicConfigRecord | title | string | no | no | maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| def:publicConfigRecord | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| def:publicConfigRecord | currency | string | no | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code, matching money.atmosphere.price. |
| def:publicConfigRecord | unitAmount | integer | no | no | minimum:0 | No description in lexicon yet. |
| def:publicConfigRecord | capacityGroup | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:publicConfigRecord | maxPerOrder | integer | no | no | minimum:1, maximum:50 | No description in lexicon yet. |
| def:publicConfigRecord | product | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:publicConfigRecord | price | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:publicConfigRecord | saleStartsAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:publicConfigRecord | saleEndsAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:publicConfigRecord | totalCapacity | integer | no | no | minimum:1, maximum:250000 | No description in lexicon yet. |
| def:publicConfigRecord | tiers | array<ref:com.atproto.repo.strongRef> | no | no | maxLength:250 | No description in lexicon yet. |
| def:publicConfigRecord | startsAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:publicConfigRecord | endsAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:publicConfigRecord | archived | boolean | yes | no | none | No description in lexicon yet. |
| def:publicConfigRecord | createdAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:publicConfigRecord | updatedAt | string | no | no | format:datetime | No description in lexicon yet. |
| def:publicConfigRecord | indexedAt | string | yes | no | format:datetime | When the AppView indexed this public ticket config record. |
tickets.atmosphere.listTicketFormResponses16 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | eventId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | organizerDid | string | yes | no | format:did | No description in lexicon yet. |
| input | organizerAssertionJwt | string | no | no | maxLength:8192 | No description in lexicon yet. |
| input | tierId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | ticketId | string | no | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | limit | integer | no | no | minimum:1, maximum:250 | No description in lexicon yet. |
| input | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| output | responses | array<ref:#formResponse> | yes | no | maxLength:250 | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:1024 | No description in lexicon yet. |
| def:formResponse | ticketId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:formResponse | tierId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:formResponse | fieldKey | string | yes | no | maxLength:64 | No description in lexicon yet. |
| def:formResponse | value | string | yes | no | maxLength:2000 | No description in lexicon yet. |
| def:formResponse | showAtCheckIn | boolean | yes | no | none | No description in lexicon yet. |
| def:formResponse | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
tickets.atmosphere.publicOffer9 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | event | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| record | tiers | array<ref:com.atproto.repo.strongRef> | yes | no | maxLength:250 | No description in lexicon yet. |
| record | title | string | no | no | maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| record | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| record | startsAt | string | no | no | format:datetime | No description in lexicon yet. |
| record | endsAt | string | no | no | format:datetime | No description in lexicon yet. |
| record | archived | boolean | no | no | none | No description in lexicon yet. |
| record | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| record | updatedAt | string | no | no | format:datetime | No description in lexicon yet. |
tickets.atmosphere.releaseTicketHold6 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | holdId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | reason | string | no | no | maxLength:200 | No description in lexicon yet. |
| output | hold | ref:#hold | yes | no | none | No description in lexicon yet. |
| def:hold | id | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:hold | status | string<released | expired | failed | completed> | yes | no | maxLength:32 | No description in lexicon yet. |
tickets.atmosphere.revokeCollaboration5 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | collaborationId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | organizerDid | string | yes | no | format:did | The revoking PRIMARY organizer (or accepted co-organizer) authorizing this revocation via event control. |
| input | organizerAssertionJwt | string | no | no | maxLength:8192 | Optional short-lived user service-auth JWT from organizerDid to ATM, scoped to tickets.atmosphere.revokeCollaboration. |
| output | collaboration | ref:tickets.atmosphere.defs#organizerCollaboration | yes | no | none | No description in lexicon yet. |
tickets.atmosphere.setTierForm16 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | tierId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | organizerDid | string | yes | no | format:did | No description in lexicon yet. |
| input | organizerAssertionJwt | string | no | no | maxLength:8192 | Optional short-lived user service-auth JWT from organizerDid to ATM, scoped to tickets.atmosphere.setTierForm. |
| input | form | ref:#form | no | yes | none | No description in lexicon yet. |
| output | tierId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| output | fieldCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:form | version | integer | yes | no | minimum:1 | Form schema version. |
| def:form | fields | array<ref:#formField> | yes | no | maxLength:30 | No description in lexicon yet. |
| def:formField | key | string | yes | no | minLength:1, maxLength:64 | No description in lexicon yet. |
| def:formField | label | string | yes | no | minLength:1, maxLength:200 | No description in lexicon yet. |
| def:formField | description | string | no | no | maxLength:1000 | Optional buyer-facing help text shown below the question. |
| def:formField | type | string<text | textarea | email | select | checkbox | boolean | number> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:formField | required | boolean | no | no | none | No description in lexicon yet. |
| def:formField | showAtCheckIn | boolean | no | no | none | Show this answer at check-in. |
| def:formField | options | array<string> | no | no | maxLength:50 | Choice values for select fields; each string is both the stored value and the display label. |
tickets.atmosphere.ticketTier14 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| record | event | ref:com.atproto.repo.strongRef | yes | no | none | No description in lexicon yet. |
| record | title | string | yes | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| record | description | string | no | no | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| record | currency | string | yes | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code, matching money.atmosphere.price. |
| record | unitAmount | integer | yes | no | minimum:0 | Amount in the smallest unit of currency. |
| record | capacityGroup | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| record | maxPerOrder | integer | no | no | minimum:1, maximum:50 | Organizer-configured per-order limit for this tier. |
| record | product | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| record | price | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| record | saleStartsAt | string | no | no | format:datetime | No description in lexicon yet. |
| record | saleEndsAt | string | no | no | format:datetime | No description in lexicon yet. |
| record | archived | boolean | no | no | none | No description in lexicon yet. |
| record | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
| record | updatedAt | string | no | no | format:datetime | No description in lexicon yet. |
tickets.atmosphere.updateCapacityGroup7 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | capacityGroupId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | name | string | no | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| input | totalCapacity | integer | no | no | minimum:1, maximum:250000 | No description in lexicon yet. |
| input | status | string<active | archived> | no | no | maxLength:32 | No description in lexicon yet. |
| input | metadata | unknown | no | no | none | No description in lexicon yet. |
| output | capacityGroup | ref:tickets.atmosphere.defs#capacityGroupSummary | yes | no | none | No description in lexicon yet. |
tickets.atmosphere.updateTicketEvent9 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | eventId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | title | string | no | no | minLength:1, maxLength:3000, maxGraphemes:300 | No description in lexicon yet. |
| input | startsAt | string | no | yes | format:datetime | No description in lexicon yet. |
| input | eventCid | string | no | yes | format:cid | No description in lexicon yet. |
| input | imageUrl | string | no | yes | maxLength:2000, format:uri | No description in lexicon yet. |
| input | status | string<active | paused | archived> | no | no | maxLength:32 | ATM ticket-sales lifecycle state. |
| input | metadata | unknown | no | no | none | No description in lexicon yet. |
| output | event | ref:tickets.atmosphere.defs#eventSummary | yes | no | none | No description in lexicon yet. |
tickets.atmosphere.updateTicketTier15 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | tierId | string | yes | no | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | title | string | no | no | minLength:1, maxLength:1000, maxGraphemes:100 | No description in lexicon yet. |
| input | description | string | no | yes | maxLength:10000, maxGraphemes:1000 | No description in lexicon yet. |
| input | currency | string | no | no | minLength:3, maxLength:3 | Lowercase ISO 4217 currency code, matching money.atmosphere.price. |
| input | unitAmount | integer | no | no | minimum:0, maximum:2000000 | Amount in the smallest unit of currency. |
| input | maxPerOrder | integer | no | no | minimum:1, maximum:50 | No description in lexicon yet. |
| input | saleStartsAt | string | no | yes | format:datetime | No description in lexicon yet. |
| input | saleEndsAt | string | no | yes | format:datetime | No description in lexicon yet. |
| input | tierRef | ref:com.atproto.repo.strongRef | no | yes | none | No description in lexicon yet. |
| input | productRef | ref:com.atproto.repo.strongRef | no | yes | none | No description in lexicon yet. |
| input | priceRef | ref:com.atproto.repo.strongRef | no | yes | none | No description in lexicon yet. |
| input | metadata | unknown | no | no | none | No description in lexicon yet. |
| input | status | string<active | paused | archived> | no | no | maxLength:32 | No description in lexicon yet. |
| output | tier | ref:tickets.atmosphere.defs#ticketTierSummary | yes | no | none | No description in lexicon yet. |
tickets.atmosphere.verifyTicket8 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| input | ticketToken | string | yes | no | minLength:1, maxLength:4000 | No description in lexicon yet. |
| output | valid | boolean | yes | no | none | No description in lexicon yet. |
| output | reason | string | no | no | maxLength:100 | No description in lexicon yet. |
| output | ticket | ref:tickets.atmosphere.defs#issuedTicket | no | no | none | No description in lexicon yet. |
| output | presentation | ref:tickets.atmosphere.defs#ticketPresentation | no | no | none | No description in lexicon yet. |
| output | event | ref:tickets.atmosphere.defs#eventSummary | no | no | none | No description in lexicon yet. |
| output | tier | ref:tickets.atmosphere.defs#ticketTierSummary | no | no | none | No description in lexicon yet. |
Contract checks
- Every public ATM-owned NSID appears in generated docs output.
- External attested.network schemas stay strict and are not hand-extended.
- Tickets XRPC methods remain visible from ATM docs because ticket purchases flow through the ATM ledger.
- Generated docs can be refreshed before posting lexicons for public review.
shell
npm run docs:checkPublic review artifacts
Pair this generated index with the lexicon review bundle when asking the AT Protocol community to review contract shape. The human review page covers design goals; this page keeps the full method and record index honest.
Human review
Design rationale and open questions.
Generated index
Every current contract and lifecycle label.
Tickets reference
Ticket-specific integration flows on atmosphere.tickets.