Docs

Generated reference

A contract index generated from the local ATM, attested.network, and Tickets lexicons.

Closed beta@atmosphere-money/app-nodeSDK beta: 0.0.0-beta.0ATM API beta: 2026-0642 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.

How this page is built

This reference is generated from the local lexicon set inapp/lexicons. It is intentionally more mechanical than the guide pages: use it to confirm NSIDs, route shape, auth expectations, lifecycle labels, and whether a contract is a PDS record or XRPC method.

shell
cd app
npm run docs:generate-reference
npm run docs:check

ATM money namespace

NSIDKindRouteAuthStatusSummaryLinks
money.atmosphere.actor.getPayoutStatusquery/xrpc/money.atmosphere.actor.getPayoutStatusPublic or app-scoped readbeta draftReturn whether an actor can receive payments through ATM.
money.atmosphere.actor.getProfilequery/xrpc/money.atmosphere.actor.getProfilePublic AppView readbeta draftReturn the indexed money.atmosphere.actor.profile record for an actor DID or handle, or null if none has been indexed.
money.atmosphere.actor.profilerecordPDSPDS recordbeta draftMinimal payment-facing profile for an Atmosphere account using ATM.
money.atmosphere.catalog.getProductquery/xrpc/money.atmosphere.catalog.getProductPublic or app-scoped readbeta draftReturn one indexed ATM catalog product by AT-URI, or null if the AppView has not indexed it.
money.atmosphere.catalog.listProductsquery/xrpc/money.atmosphere.catalog.listProductsPublic or app-scoped readbeta draftList indexed ATM catalog products for a creator, with optional default price and sales-count projections.
money.atmosphere.discountrecordPDSPDS recordbeta draftPublic ATM discount terms that can be mirrored to processor coupon objects at checkout.
money.atmosphere.discountCoderecordPDSPDS recordbeta draftPublic customer-facing redemption code for a money.atmosphere.discount.
money.atmosphere.event.receiveprocedure/xrpc/money.atmosphere.event.receiveApp service-authbeta draftOptional app-implemented XRPC receiver for ATM outbound events.
money.atmosphere.payment.cancelSubscriptionprocedure/xrpc/money.atmosphere.payment.cancelSubscriptionApp service-authbeta draftCancel a subscription on behalf of the authenticated payer.
money.atmosphere.payment.declineRecordprocedure/xrpc/money.atmosphere.payment.declineRecordApp service-authbeta draftSignal that the originating app cannot write a delegated record.
money.atmosphere.payment.listPendingRecordsquery/xrpc/money.atmosphere.payment.listPendingRecordsPublic or app-scoped readbeta draftList pending payer/creator records the originating app may upgrade.
money.atmosphere.payment.listSubscriptionsquery/xrpc/money.atmosphere.payment.listSubscriptionsPublic or app-scoped readbeta draftList active subscriptions for the authenticated payer.
money.atmosphere.payment.registerCreatorProofprocedure/xrpc/money.atmosphere.payment.registerCreatorProofApp service-authbeta draftRegister a creator proof URI written by the originating app on the creator's PDS via OAuth.
money.atmosphere.payment.registerPayerRecordprocedure/xrpc/money.atmosphere.payment.registerPayerRecordApp service-authbeta draftRegister a payer record URI written by the originating app on the payer's PDS via OAuth.
money.atmosphere.pricerecordPDSPDS recordbeta draftPublic ATM price record describing amount, currency, and billing cadence for a product.
money.atmosphere.productrecordPDSPDS recordbeta draftPublic ATM catalog product describing what is sold; prices live in money.atmosphere.price.

ATM money fields

money.atmosphere.actor.getPayoutStatus17 fields
LocationFieldTypeRequiredNullableLimitsDescription
outputstatusstringyesnomaxLength:64No description in lexicon yet.
outputchargesEnabledbooleanyesnononeNo description in lexicon yet.
outputpayoutsEnabledbooleanyesnononeNo description in lexicon yet.
outputdetailsSubmittedbooleanyesnononeNo description in lexicon yet.
outputrequirementsDuearray<string>nonononeNo description in lexicon yet.
outputcurrentlyDueintegernonononeNo description in lexicon yet.
outputpastDueintegernonononeNo description in lexicon yet.
outputeventuallyDueintegernonononeNo description in lexicon yet.
outputdisabledReasonstringnonomaxLength:128No description in lexicon yet.
outputcurrentDeadlinestringnonoformat:datetimeNo description in lexicon yet.
outputerrorsarray<string>nonononeNo description in lexicon yet.
outputmessagestringnonomaxLength:512No description in lexicon yet.
outputaccountLinkedbooleannonononeNo description in lexicon yet.
outputsupportRequiredbooleannonononeNo description in lexicon yet.
outputhasHistorybooleannonononeNo description in lexicon yet.
outputinternalOwnerbooleannonononeNo description in lexicon yet.
outputsameLegalEntitybooleannonononeNo description in lexicon yet.
money.atmosphere.actor.getProfile4 fields
LocationFieldTypeRequiredNullableLimitsDescription
outputprofileref:#profileyesyesnoneEither null or { uri, cid, value } where value is money.atmosphere.actor.profile.
def:profileuristringyesnoformat:at-uriNo description in lexicon yet.
def:profilecidstringyesnoformat:cidNo description in lexicon yet.
def:profilevalueref:money.atmosphere.actor.profileyesnononeNo description in lexicon yet.
money.atmosphere.actor.profile5 fields
LocationFieldTypeRequiredNullableLimitsDescription
recorddisplayNamestringnonomaxLength:640, maxGraphemes:64Payment-facing display name.
recorddescriptionstringnonomaxLength:2560, maxGraphemes:256Short payment-facing profile text.
recordavatarblobnonononePayment-facing avatar image.
recordcreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
recordupdatedAtstringyesnoformat:datetimeNo description in lexicon yet.
money.atmosphere.catalog.getProduct30 fields
LocationFieldTypeRequiredNullableLimitsDescription
outputproductref:#catalogProductyesyesnoneNo description in lexicon yet.
def:catalogPriceuristringyesnoformat:at-uriNo description in lexicon yet.
def:catalogPricecidstringyesnoformat:cidNo description in lexicon yet.
def:catalogPricecurrencystringyesnominLength:3, maxLength:3No description in lexicon yet.
def:catalogPriceunitAmountintegeryesnominimum:1No description in lexicon yet.
def:catalogPricecustomUnitAmountref:#catalogPriceCustomUnitAmountnoyesnoneNo description in lexicon yet.
def:catalogPricetypestring<one-time | recurring>yesnomaxLength:16No description in lexicon yet.
def:catalogPricerecurringref:#catalogPriceRecurringnoyesnoneNo description in lexicon yet.
def:catalogPricearchivedbooleanyesnononeNo description in lexicon yet.
def:catalogPricecreatedAtstringnonoformat:datetimeNo description in lexicon yet.
def:catalogProducturistringyesnoformat:at-uriNo description in lexicon yet.
def:catalogProductcidstringyesnoformat:cidNo description in lexicon yet.
def:catalogProducttitlestringyesnominLength:1, maxLength:1000, maxGraphemes:100No description in lexicon yet.
def:catalogProductskustringnonomaxLength:64No description in lexicon yet.
def:catalogProductdefaultPriceref:#catalogPricenoyesnoneNo description in lexicon yet.
def:catalogProductkindstring<physical | digital | commission | service | ticket | other>yesnomaxLength:32No description in lexicon yet.
def:catalogProductdescriptionstringnonomaxLength:10000, maxGraphemes:1000No description in lexicon yet.
def:catalogProductimageUrlstringnonoformat:uriNo description in lexicon yet.
def:catalogProductvariantOfref:com.atproto.repo.strongRefnoyesnoneNo description in lexicon yet.
def:catalogProductarchivedbooleanyesnononeNo description in lexicon yet.
def:catalogProductarchivedAtstringnonoformat:datetimeNo description in lexicon yet.
def:catalogProductcreatedAtstringnonoformat:datetimeNo description in lexicon yet.
def:catalogProductindexedAtintegeryesnononeNo description in lexicon yet.
def:catalogProductsalesCountintegernonominimum:0No description in lexicon yet.
def:catalogPriceCustomUnitAmountenabledbooleanyesnononeNo description in lexicon yet.
def:catalogPriceCustomUnitAmountpresetintegernonominimum:1No description in lexicon yet.
def:catalogPriceCustomUnitAmountminimumintegernonominimum:1No description in lexicon yet.
def:catalogPriceCustomUnitAmountmaximumintegernonominimum:1No description in lexicon yet.
def:catalogPriceRecurringintervalstring<day | week | month | year>yesnomaxLength:16No description in lexicon yet.
def:catalogPriceRecurringintervalCountintegeryesnominimum:1, maximum:36No description in lexicon yet.
money.atmosphere.catalog.listProducts31 fields
LocationFieldTypeRequiredNullableLimitsDescription
outputproductsarray<ref:#catalogProduct>yesnononeNo description in lexicon yet.
outputcursorstringnonomaxLength:512No description in lexicon yet.
def:catalogPriceuristringyesnoformat:at-uriNo description in lexicon yet.
def:catalogPricecidstringyesnoformat:cidNo description in lexicon yet.
def:catalogPricecurrencystringyesnominLength:3, maxLength:3No description in lexicon yet.
def:catalogPriceunitAmountintegeryesnominimum:1No description in lexicon yet.
def:catalogPricecustomUnitAmountref:#catalogPriceCustomUnitAmountnoyesnoneNo description in lexicon yet.
def:catalogPricetypestring<one-time | recurring>yesnomaxLength:16No description in lexicon yet.
def:catalogPricerecurringref:#catalogPriceRecurringnoyesnoneNo description in lexicon yet.
def:catalogPricearchivedbooleanyesnononeNo description in lexicon yet.
def:catalogPricecreatedAtstringnonoformat:datetimeNo description in lexicon yet.
def:catalogProducturistringyesnoformat:at-uriNo description in lexicon yet.
def:catalogProductcidstringyesnoformat:cidNo description in lexicon yet.
def:catalogProducttitlestringyesnominLength:1, maxLength:1000, maxGraphemes:100No description in lexicon yet.
def:catalogProductskustringnonomaxLength:64No description in lexicon yet.
def:catalogProductdefaultPriceref:#catalogPricenoyesnoneNo description in lexicon yet.
def:catalogProductkindstring<physical | digital | commission | service | ticket | other>yesnomaxLength:32No description in lexicon yet.
def:catalogProductdescriptionstringnonomaxLength:10000, maxGraphemes:1000No description in lexicon yet.
def:catalogProductimageUrlstringnonoformat:uriNo description in lexicon yet.
def:catalogProductvariantOfref:com.atproto.repo.strongRefnoyesnoneNo description in lexicon yet.
def:catalogProductarchivedbooleanyesnononeNo description in lexicon yet.
def:catalogProductarchivedAtstringnonoformat:datetimeNo description in lexicon yet.
def:catalogProductcreatedAtstringnonoformat:datetimeNo description in lexicon yet.
def:catalogProductindexedAtintegeryesnononeNo description in lexicon yet.
def:catalogProductsalesCountintegernonominimum:0No description in lexicon yet.
def:catalogPriceCustomUnitAmountenabledbooleanyesnononeNo description in lexicon yet.
def:catalogPriceCustomUnitAmountpresetintegernonominimum:1No description in lexicon yet.
def:catalogPriceCustomUnitAmountminimumintegernonominimum:1No description in lexicon yet.
def:catalogPriceCustomUnitAmountmaximumintegernonominimum:1No description in lexicon yet.
def:catalogPriceRecurringintervalstring<day | week | month | year>yesnomaxLength:16No description in lexicon yet.
def:catalogPriceRecurringintervalCountintegeryesnominimum:1, maximum:36No description in lexicon yet.
money.atmosphere.discount15 fields
LocationFieldTypeRequiredNullableLimitsDescription
recordnamestringnonomaxLength:1000, maxGraphemes:100No description in lexicon yet.
recordpercentOffBpsintegernonominimum:1, maximum:10000Percentage discount in basis points.
recordamountOffref:#amountOffnonononeNo description in lexicon yet.
recorddurationstring<once | forever | repeating>nonomaxLength:16Stripe-compatible discount duration.
recorddurationInMonthsintegernonominimum:1, maximum:36Required when duration is repeating.
recordappliesToref:#appliesTononononeNo description in lexicon yet.
recordmaxRedemptionsintegernonominimum:1No description in lexicon yet.
recordredeemBystringnonoformat:datetimeNo description in lexicon yet.
recorddisabledbooleannonononeNo description in lexicon yet.
recordcreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
recordupdatedAtstringnonoformat:datetimeNo description in lexicon yet.
def:amountOffcurrencystringyesnominLength:3, maxLength:3Lowercase ISO 4217 currency code.
def:amountOffunitAmountintegeryesnominimum:1Amount off in the smallest currency unit.
def:appliesToproductUrisarray<string>nonononeATM product URIs this discount can apply to.
def:appliesTopriceUrisarray<string>nonononeATM price URIs this discount can apply to.
money.atmosphere.discountCode13 fields
LocationFieldTypeRequiredNullableLimitsDescription
recorddiscountref:com.atproto.repo.strongRefyesnononeStrongRef to the money.atmosphere.discount this code redeems.
recordcodestringyesnomaxLength:64Customer-facing code.
recordnamestringnonomaxLength:1000, maxGraphemes:100No description in lexicon yet.
recordrestrictionsref:#restrictionsnonononeNo description in lexicon yet.
recordmaxRedemptionsintegernonominimum:1No description in lexicon yet.
recordredeemBystringnonoformat:datetimeNo description in lexicon yet.
recorddisabledbooleannonononeNo description in lexicon yet.
recordcreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
recordupdatedAtstringnonoformat:datetimeNo description in lexicon yet.
def:restrictionsfirstTimeTransactionbooleannonononeStripe-compatible first-time transaction restriction.
def:restrictionsminimumAmountref:#restrictionsMinimumAmountnonononeNo description in lexicon yet.
def:restrictionsMinimumAmountcurrencystringyesnominLength:3, maxLength:3Lowercase ISO 4217 currency code.
def:restrictionsMinimumAmountunitAmountintegeryesnominimum:1Minimum payment amount in the smallest currency unit.
money.atmosphere.event.receive121 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputidstringyesnononeATM delivery id.
inputtypestring<app.webhook.test | payment.completed | payment.failed | payment.refunded | payment.disputed | subscription.invoice_paid | subscription.updated | subscription.cancelled | payer.record.requested | creator.proof.requested | attestation.updated | product.updated | product.archived | product.deleted | ticket.hold.created | ticket.hold.expired | tickets.issued | ticket.voided | ticket.refunded | ticket.checked_in>yesnononeATM event type, such as payment.completed or tickets.issued.
inputcreatedintegeryesnononeUnix timestamp, in seconds, when ATM built the event envelope.
inputapiVersionstringyesnononeATM outbound event envelope version.
inputenvironmentstring<test | live>nonononeATM app environment for this delivery.
inputdataunknownyesnononeEvent-specific payload.
outputacceptedbooleannonononeOptional acknowledgement.
def:paymentidstringyesnononeNo description in lexicon yet.
def:paymentpaymentTypestringnonononeNo description in lexicon yet.
def:paymentamountstringnonononeNo description in lexicon yet.
def:paymentamountCentsintegernonononeNo description in lexicon yet.
def:paymentcurrencystringnonominLength:3, maxLength:3No description in lexicon yet.
def:paymentstatusstringnonononeNo description in lexicon yet.
def:paymentpayerDidstringnonoformat:didNo description in lexicon yet.
def:paymentrecipientDidstringnonoformat:didNo description in lexicon yet.
def:paymentmetadataunknownnonononeNo description in lexicon yet.
def:paymentlistingref:com.atproto.repo.strongRefnonononeNo description in lexicon yet.
def:paymententitlementsarray<ref:com.atproto.repo.strongRef>nonononeNo description in lexicon yet.
def:invoiceidstringyesnononeNo description in lexicon yet.
def:invoicesubscriptionIdstringnonononeNo description in lexicon yet.
def:invoiceamountstringnonononeNo description in lexicon yet.
def:invoiceamountCentsintegernonononeNo description in lexicon yet.
def:invoicecurrencystringnonominLength:3, maxLength:3No description in lexicon yet.
def:invoicefirstInvoicebooleannonononeNo description in lexicon yet.
def:subscriptionidstringyesnononeNo description in lexicon yet.
def:subscriptionstatusstringnonononeNo description in lexicon yet.
def:subscriptionmetadataunknownnonononeNo description in lexicon yet.
def:ticketHoldidstringyesnononeNo description in lexicon yet.
def:ticketHoldeventIdstringnonononeNo description in lexicon yet.
def:ticketHoldpaymentIdstringnonononeNo description in lexicon yet.
def:ticketHoldstatusstringnonononeNo description in lexicon yet.
def:ticketHoldreasonstringnonononeNo description in lexicon yet.
def:ticketHolditemsarray<ref:#ticketHoldItem>nonononeNo description in lexicon yet.
def:ticketHoldItemtierIdstringyesnononeNo description in lexicon yet.
def:ticketHoldItemtitlestringnonononeNo description in lexicon yet.
def:ticketHoldItemquantityintegernonononeNo description in lexicon yet.
def:ticketHoldItemunitAmountintegernonononeNo description in lexicon yet.
def:ticketHoldItemcurrencystringnonominLength:3, maxLength:3No description in lexicon yet.
def:issuedTicketidstringyesnononeNo description in lexicon yet.
def:issuedTicketeventIdstringnonononeNo description in lexicon yet.
def:issuedTickettierIdstringnonononeNo description in lexicon yet.
def:issuedTicketpaymentIdstringnonononeNo description in lexicon yet.
def:issuedTicketclaimIdstringnonononeNo description in lexicon yet.
def:issuedTicketstatusstringnonononeNo description in lexicon yet.
def:producturistringyesnoformat:at-uriNo description in lexicon yet.
def:productcidstringnonoformat:cidNo description in lexicon yet.
def:attestationcidstringnonoformat:cidNo description in lexicon yet.
def:attestationmodestringnonononeNo description in lexicon yet.
def:distributionplannedintegeryesnominimum:0No description in lexicon yet.
def:appWebhookTestmessagestringnonononeNo description in lexicon yet.
def:paymentCompletedpaymentref:#paymentyesnononeNo description in lexicon yet.
def:paymentCompleteddistributionref:#distributionnonononeNo description in lexicon yet.
def:paymentCompletedticketsunknownnonononeNo description in lexicon yet.
def:paymentCompletedattestationref:#attestationnonononeNo description in lexicon yet.
def:paymentFailedpaymentref:#paymentyesnononeNo description in lexicon yet.
def:paymentFailedreasonstringnonononeNo description in lexicon yet.
def:paymentRefundedpaymentref:#paymentyesnononeNo description in lexicon yet.
def:paymentRefundedamountintegernonominimum:0No description in lexicon yet.
def:paymentRefundedreasonstringnonononeNo description in lexicon yet.
def:paymentRefundeddistributionref:#distributionnonononeNo description in lexicon yet.
def:paymentDisputedpaymentref:#paymentyesnononeNo description in lexicon yet.
def:paymentDisputedreasonstringnonononeNo description in lexicon yet.
def:paymentDisputeddisputeReasonstringnonononeNo description in lexicon yet.
def:paymentDisputedstatusstringnonononeNo description in lexicon yet.
def:subscriptionInvoicePaidpaymentref:#paymentyesnononeNo description in lexicon yet.
def:subscriptionInvoicePaidinvoiceref:#invoiceyesnononeNo description in lexicon yet.
def:subscriptionInvoicePaidinvoiceIdstringnonononeNo description in lexicon yet.
def:subscriptionInvoicePaiddistributionref:#distributionnonononeNo description in lexicon yet.
def:subscriptionInvoicePaidattestationref:#attestationnonononeNo description in lexicon yet.
def:subscriptionUpdatedsubscriptionref:#subscriptionyesnononeNo description in lexicon yet.
def:subscriptionUpdatedpaymentref:#paymentyesnononeNo description in lexicon yet.
def:subscriptionUpdatedpreviousPaymentref:#paymentnonononeNo description in lexicon yet.
def:subscriptionUpdatedpriorAmountCentsintegeryesnominimum:0No description in lexicon yet.
def:subscriptionUpdatedamountCentsintegeryesnominimum:0No description in lexicon yet.
def:subscriptionUpdatedcurrencystringyesnominLength:3, maxLength:3No description in lexicon yet.
def:subscriptionUpdatedupdatedAtstringyesnoformat:datetimeNo description in lexicon yet.
def:subscriptionUpdatedcurrentPeriodEndstringnonoformat:datetimeNo description in lexicon yet.
def:subscriptionUpdatedupdatedByunknownnonononeNo description in lexicon yet.
def:subscriptionUpdatedattestationref:#attestationnonononeNo description in lexicon yet.
def:subscriptionCancelledsubscriptionref:#subscriptionyesnononeNo description in lexicon yet.
def:subscriptionCancelledpaymentref:#paymentyesnononeNo description in lexicon yet.
def:subscriptionCancelledcancelledAtstringyesnoformat:datetimeNo description in lexicon yet.
def:subscriptionCancelledcancelledByunknownnonononeNo description in lexicon yet.
def:subscriptionCancelledreasonstringnonononeNo description in lexicon yet.
def:payerRecordRequestedpaymentIdstringyesnononeNo description in lexicon yet.
def:payerRecordRequestedpayerDidstringyesnoformat:didNo description in lexicon yet.
def:payerRecordRequestedrecipientDidstringyesnoformat:didNo description in lexicon yet.
def:payerRecordRequestedcollectionstringyesnononeNo description in lexicon yet.
def:payerRecordRequestedcanonicalRecordunknownyesnononeNo description in lexicon yet.
def:payerRecordRequestedexpectedCidstringyesnoformat:cidNo description in lexicon yet.
def:payerRecordRequestedexpiresAtstringyesnoformat:datetimeNo description in lexicon yet.
def:creatorProofRequestedpaymentIdstringyesnononeNo description in lexicon yet.
def:creatorProofRequestedcreatorDidstringyesnoformat:didNo description in lexicon yet.
def:creatorProofRequestedattestationCidstringyesnoformat:cidNo description in lexicon yet.
def:creatorProofRequestedpayerProofRefref:com.atproto.repo.strongRefnonononeNo description in lexicon yet.
def:creatorProofRequestedproofRecordunknownyesnononeNo description in lexicon yet.
def:creatorProofRequestedexpiresAtstringyesnoformat:datetimeNo description in lexicon yet.
def:attestationUpdatedpaymentIdstringyesnononeNo description in lexicon yet.
def:productUpdatedproductref:#productyesnononeNo description in lexicon yet.
def:productUpdatedcreatorDidstringnonoformat:didNo description in lexicon yet.
def:productUpdatedappLinkunknownnonononeNo description in lexicon yet.
def:productArchivedproductref:#productyesnononeNo description in lexicon yet.
def:productArchivedcreatorDidstringnonoformat:didNo description in lexicon yet.
def:productArchivedappLinkunknownnonononeNo description in lexicon yet.
def:productDeletedproductref:#productyesnononeNo description in lexicon yet.
def:productDeletedcreatorDidstringnonoformat:didNo description in lexicon yet.
def:productDeletedappLinkunknownnonononeNo description in lexicon yet.
def:ticketHoldCreatedholdref:#ticketHoldyesnononeNo description in lexicon yet.
def:ticketHoldExpiredholdref:#ticketHoldyesnononeNo description in lexicon yet.
def:ticketsIssuedpaymentIdstringnonononeNo description in lexicon yet.
def:ticketsIssuedclaimIdstringnonononeNo description in lexicon yet.
def:ticketsIssuedholdref:#ticketHoldyesnononeNo description in lexicon yet.
def:ticketsIssuedticketsarray<ref:#issuedTicket>yesnononeNo description in lexicon yet.
def:ticketVoidedpaymentIdstringyesnononeNo description in lexicon yet.
def:ticketVoidedreasonstringnonononeNo description in lexicon yet.
def:ticketVoidedticketsarray<ref:#issuedTicket>yesnononeNo description in lexicon yet.
def:ticketRefundedpaymentIdstringyesnononeNo description in lexicon yet.
def:ticketRefundedreasonstringnonononeNo description in lexicon yet.
def:ticketRefundedticketsarray<ref:#issuedTicket>yesnononeNo description in lexicon yet.
def:ticketCheckedInticketref:#issuedTicketyesnononeNo description in lexicon yet.
def:ticketCheckedIncheckInunknownyesnononeNo description in lexicon yet.
money.atmosphere.payment.cancelSubscription5 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputpaymentIdstringyesnomaxLength:128No description in lexicon yet.
inputreasonstringnonomaxLength:256No description in lexicon yet.
outputpaymentIdstringyesnomaxLength:128No description in lexicon yet.
outputstatusstringyesnomaxLength:64No description in lexicon yet.
outputcancelledAtstringyesnoformat:datetimeNo description in lexicon yet.
money.atmosphere.payment.declineRecord6 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputpaymentIdstringyesnomaxLength:128No description in lexicon yet.
inputrecordTypestring<payer | creator>yesnomaxLength:16No description in lexicon yet.
inputreasonstringnonomaxLength:256No description in lexicon yet.
outputpaymentIdstringyesnomaxLength:128No description in lexicon yet.
outputrecordTypestring<payer | creator>yesnomaxLength:16No description in lexicon yet.
outputresolvedViastring<broker | declined>yesnomaxLength:16No description in lexicon yet.
money.atmosphere.payment.listPendingRecords10 fields
LocationFieldTypeRequiredNullableLimitsDescription
outputrecordsarray<ref:#records>yesnononeNo description in lexicon yet.
outputcursorstringnonomaxLength:512No description in lexicon yet.
def:recordspaymentIdstringyesnomaxLength:128No description in lexicon yet.
def:recordsrecordTypestring<payer | creator>yesnomaxLength:16No description in lexicon yet.
def:recordspayerDidstringnonoformat:didNo description in lexicon yet.
def:recordsrecipientDidstringnonoformat:didNo description in lexicon yet.
def:recordscollectionstringnonoformat:nsidNo description in lexicon yet.
def:recordscanonicalRecordunknownnonononeNo description in lexicon yet.
def:recordsattestationCidstringnonoformat:cidNo description in lexicon yet.
def:recordsexpectedCidstringyesnoformat:cidNo description in lexicon yet.
money.atmosphere.payment.listSubscriptions13 fields
LocationFieldTypeRequiredNullableLimitsDescription
outputsubscriptionsarray<ref:#subscription>yesnononeNo description in lexicon yet.
outputcursorstringnonomaxLength:512No description in lexicon yet.
def:subscriptionpaymentIdstringyesnomaxLength:128No description in lexicon yet.
def:subscriptionrecipientDidstringyesnoformat:didNo description in lexicon yet.
def:subscriptionoriginatorDidstringyesnoformat:didNo description in lexicon yet.
def:subscriptionamountCentsintegeryesnononeNo description in lexicon yet.
def:subscriptioncurrencystringyesnominLength:3, maxLength:3No description in lexicon yet.
def:subscriptionintervalstring<month | quarter | year>nonomaxLength:16No description in lexicon yet.
def:subscriptionstatusstringyesnomaxLength:64No description in lexicon yet.
def:subscriptionmetadataunknownnonononeSanitized public display hints only.
def:subscriptionentitlementsarray<ref:com.atproto.repo.strongRef>nonononeNo description in lexicon yet.
def:subscriptionlistingref:com.atproto.repo.strongRefnonononeNo description in lexicon yet.
def:subscriptioncreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
money.atmosphere.payment.registerCreatorProof7 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputpaymentIdstringyesnomaxLength:128No description in lexicon yet.
inputcreatorProofUristringyesnoformat:at-uriNo description in lexicon yet.
inputcreatorProofCidstringyesnoformat:cidNo description in lexicon yet.
outputpaymentIdstringyesnomaxLength:128No description in lexicon yet.
outputcreatorProofUristringyesnoformat:at-uriNo description in lexicon yet.
outputcreatorProofCidstringyesnoformat:cidNo description in lexicon yet.
outputalreadyRegisteredbooleannonononeNo description in lexicon yet.
money.atmosphere.payment.registerPayerRecord7 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputpaymentIdstringyesnomaxLength:128No description in lexicon yet.
inputpayerProofUristringyesnoformat:at-uriNo description in lexicon yet.
inputpayerProofCidstringyesnoformat:cidNo description in lexicon yet.
outputpaymentIdstringyesnomaxLength:128No description in lexicon yet.
outputpayerProofUristringyesnoformat:at-uriNo description in lexicon yet.
outputpayerProofCidstringyesnoformat:cidNo description in lexicon yet.
outputalreadyRegisteredbooleannonononeNo description in lexicon yet.
money.atmosphere.price17 fields
LocationFieldTypeRequiredNullableLimitsDescription
recordproductUristringyesnoformat:at-uriNo description in lexicon yet.
recordlookupKeystringnonomaxLength:200No description in lexicon yet.
recordnicknamestringnonomaxLength:1000, maxGraphemes:100No description in lexicon yet.
recordcurrencystringyesnominLength:3, maxLength:3Lowercase ISO 4217 currency code, matching Stripe Price.
recordunitAmountintegeryesnominimum:1No description in lexicon yet.
recordcustomUnitAmountref:#customUnitAmountnonononeStripe-compatible customer-chosen amount configuration.
recordtypestring<one-time | recurring>yesnomaxLength:16No description in lexicon yet.
recordrecurringref:#recurringnonononeNo description in lexicon yet.
recordarchivedbooleannonononeNo description in lexicon yet.
recordcreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
recordupdatedAtstringnonoformat:datetimeNo description in lexicon yet.
def:customUnitAmountenabledbooleanyesnononeNo description in lexicon yet.
def:customUnitAmountpresetintegernonominimum:1Initial amount shown to the buyer, in the smallest unit of currency.
def:customUnitAmountminimumintegernonominimum:1Minimum buyer-entered amount, in the smallest unit of currency.
def:customUnitAmountmaximumintegernonominimum:1Maximum buyer-entered amount, in the smallest unit of currency.
def:recurringintervalstring<day | week | month | year>yesnomaxLength:16No description in lexicon yet.
def:recurringintervalCountintegeryesnominimum:1, maximum:36No description in lexicon yet.
money.atmosphere.product13 fields
LocationFieldTypeRequiredNullableLimitsDescription
recordtitlestringyesnominLength:1, maxLength:1000, maxGraphemes:100No description in lexicon yet.
recordskustringnonomaxLength:64No description in lexicon yet.
recorddefaultPriceref:com.atproto.repo.strongRefnonononeNo description in lexicon yet.
recordkindstring<physical | digital | commission | service | ticket | other>yesnomaxLength:32No description in lexicon yet.
recorddescriptionstringnonomaxLength:10000, maxGraphemes:1000No description in lexicon yet.
recordimageref:#imagenonononeNo description in lexicon yet.
recordvariantOfref:com.atproto.repo.strongRefnonononeNo description in lexicon yet.
recordarchivedbooleannonononeNo description in lexicon yet.
recordarchivedAtstringnonoformat:datetimeNo description in lexicon yet.
recordcreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
recordupdatedAtstringnonoformat:datetimeNo description in lexicon yet.
def:imageuristringyesnoformat:uriNo description in lexicon yet.
def:imagealtstringnonomaxLength:3000, maxGraphemes:300No 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.

NSIDKindRouteAuthStatusSummaryLinks
network.attested.payment.initiateprocedure/xrpc/network.attested.payment.initiateattested.network servicer authexternal specBegin a payment flow.
network.attested.payment.lookupquery/xrpc/network.attested.payment.lookupPublic or app-scoped readexternal specLook up verified payment records between a payer and a recipient.
network.attested.payment.oneTimerecordPDSPDS recordexternal specA one-time payment from a supporter to a creator.
network.attested.payment.proofrecordPDSPDS recordexternal specA remote attestation record stored in the attestor's repository (creator or broker).
network.attested.payment.recurringrecordPDSPDS recordexternal specA recurring payment commitment.
network.attested.payment.scheduledrecordPDSPDS recordexternal specA fixed series of payments.
network.attested.payment.statusquery/xrpc/network.attested.payment.statusPublic or app-scoped readexternal specCheck the status of a payment initiated via network.attested.payment.initiate.

attested.network fields

network.attested.payment.initiate3 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputproductstringyesnononeProduct identifier for the payment being initiated.
outputurlstringyesnoformat:uriURL to direct the payer to in a browser to complete the payment flow (entering payment details, confirming terms, etc).
outputtokenstringyesnononeOpaque token used to poll payment status via network.attested.payment.status.
network.attested.payment.lookup1 fields
LocationFieldTypeRequiredNullableLimitsDescription
outputpaymentsarray<union>yesnononeList of verified payment records.
network.attested.payment.oneTime8 fields
LocationFieldTypeRequiredNullableLimitsDescription
recordmemostringnonomaxLength:1024, maxGraphemes:256Optional note from the supporter.
recordtxnidstringyesnomaxLength:64Unique transaction identifier for deduplication.
recordamountintegeryesnominimum:1Payment amount in the smallest unit of the given currency (e.g.
recordsubjectstringyesnoformat:didDID of the creator receiving payment.
recordcurrencystringyesnominLength:3, maxLength:3ISO 4217 currency code (e.g.
recordcreatedAtstringyesnoformat:datetimeTimestamp of record creation.
recordsignaturesarray<ref:com.atproto.repo.strongRef>nonononeAttestation entries.
recordentitlementsarray<ref:com.atproto.repo.strongRef>nonononeOptional 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
LocationFieldTypeRequiredNullableLimitsDescription
recordcidstringyesnoformat:cidAttestation CID computed per the badge.blue spec from the payment record, metadata, and repository DID.
recordstatusstringnonononeOptional status indicator for the attestation (implementation-defined).
network.attested.payment.recurring9 fields
LocationFieldTypeRequiredNullableLimitsDescription
recordunitstring<monthly | quarterly | semiannual | yearly>yesnononeBilling period.
recordtxnidstringyesnomaxLength:64Unique transaction identifier for deduplication.
recordamountintegeryesnominimum:1Amount per billing period in the smallest unit of the given currency.
recordsubjectstringyesnoformat:didDID of the creator receiving payment.
recordcurrencystringyesnominLength:3, maxLength:3ISO 4217 currency code (e.g.
recordcreatedAtstringyesnoformat:datetimeTimestamp of initial subscription creation.
recordfrequencyintegernonominimum:1Billing frequency multiplier applied to the unit (e.g.
recordsignaturesarray<ref:com.atproto.repo.strongRef>nonononeAttestation entries.
recordentitlementsarray<ref:com.atproto.repo.strongRef>nonononeOptional 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
LocationFieldTypeRequiredNullableLimitsDescription
recordunitstring<monthly | quarterly | semiannual | yearly>yesnononeInterval between scheduled payments.
recordcountintegeryesnominimum:2, maximum:60Total number of scheduled payments.
recordtxnidstringyesnomaxLength:64Unique transaction identifier for deduplication.
recordamountintegeryesnominimum:1Amount per payment in the smallest unit of the given currency.
recordsubjectstringyesnoformat:didDID of the creator receiving payment.
recordcurrencystringyesnominLength:3, maxLength:3ISO 4217 currency code (e.g.
recordcreatedAtstringyesnoformat:datetimeTimestamp of schedule creation; also the first payment date.
recordsignaturesarray<ref:com.atproto.repo.strongRef>nonononeAttestation entries.
recordentitlementsarray<ref:com.atproto.repo.strongRef>nonononeOptional list of strong references to records representing goods or services the payer is entitled to as a result of this payment.
network.attested.payment.status2 fields
LocationFieldTypeRequiredNullableLimitsDescription
outputrefref:com.atproto.repo.strongRefnonononePresent when status is 'completed'.
outputstatusstring<pending | completed | failed>yesnononeCurrent 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.

NSIDKindRouteAuthStatusSummaryLinks
tickets.atmosphere.archiveTicketTierprocedure/xrpc/tickets.atmosphere.archiveTicketTierApp service-authbeta draftArchive an app-scoped ATM Tickets tier.
tickets.atmosphere.capacityGrouprecordPDSPDS recordbeta draftPublic capacity-group label for a ticketed event.
tickets.atmosphere.checkInListrecordPDSPDS recordbeta draftPublic check-in list label for an event.
tickets.atmosphere.checkInTicketprocedure/xrpc/tickets.atmosphere.checkInTicketApp service-authbeta draftVerify and check in a private ATM Tickets scan token.
tickets.atmosphere.claimFreeTicketprocedure/xrpc/tickets.atmosphere.claimFreeTicketApp service-authbeta draftAtomically claim zero-price scarce tickets for a verified buyer without checkout redirect.
tickets.atmosphere.createCapacityGroupprocedure/xrpc/tickets.atmosphere.createCapacityGroupApp service-authbeta draftCreate a private capacity group for an app-scoped ticketed event.
tickets.atmosphere.createTicketHoldprocedure/xrpc/tickets.atmosphere.createTicketHoldApp service-authbeta draftAtomically reserve ticket capacity and return an ATM checkout URL.
tickets.atmosphere.createTicketTierprocedure/xrpc/tickets.atmosphere.createTicketTierApp service-authbeta draftCreate an app-scoped ATM Tickets tier and optional public ticket-tier refs for an event.
tickets.atmosphere.defsdefs/xrpc/tickets.atmosphere.defsApp service-authbeta draftNo description in lexicon yet.
tickets.atmosphere.getTicketAvailabilityquery/xrpc/tickets.atmosphere.getTicketAvailabilityPublic or app-scoped readbeta draftRead app-scoped ticket availability derived from private ATM holds and issued tickets.
tickets.atmosphere.listBuyerTicketsquery/xrpc/tickets.atmosphere.listBuyerTicketsPublic or app-scoped readbeta draftList app-scoped issued tickets for a buyer or payment.
tickets.atmosphere.listOrganizerTicketsquery/xrpc/tickets.atmosphere.listOrganizerTicketsPublic or app-scoped readbeta draftList app-scoped issued tickets for an organizer or event.
tickets.atmosphere.publicOfferrecordPDSPDS recordbeta draftPublic offer grouping for event tickets.
tickets.atmosphere.releaseTicketHoldprocedure/xrpc/tickets.atmosphere.releaseTicketHoldApp service-authbeta draftRelease an active ticket hold before checkout completes.
tickets.atmosphere.ticketTierrecordPDSPDS recordbeta draftPublic ticket tier metadata for an AT Protocol event.
tickets.atmosphere.updateCapacityGroupprocedure/xrpc/tickets.atmosphere.updateCapacityGroupApp service-authbeta draftUpdate a private capacity group for an app-scoped ticketed event.
tickets.atmosphere.updateTicketTierprocedure/xrpc/tickets.atmosphere.updateTicketTierApp service-authbeta draftUpdate app-scoped ATM Tickets tier metadata.
tickets.atmosphere.verifyTicketprocedure/xrpc/tickets.atmosphere.verifyTicketApp service-authbeta draftVerify a private ATM Tickets scan token without mutating check-in state.

Tickets fields

tickets.atmosphere.archiveTicketTier5 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
inputtierIdstringyesnominLength:1, maxLength:300No description in lexicon yet.
outputtierref:#tieryesnononeNo description in lexicon yet.
def:tieridstringyesnomaxLength:300No description in lexicon yet.
def:tierstatusstring<archived>yesnomaxLength:32No description in lexicon yet.
tickets.atmosphere.capacityGroup5 fields
LocationFieldTypeRequiredNullableLimitsDescription
recordeventref:com.atproto.repo.strongRefyesnononeNo description in lexicon yet.
recordnamestringyesnominLength:1, maxLength:1000, maxGraphemes:100No description in lexicon yet.
recordarchivedbooleannonononeNo description in lexicon yet.
recordcreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
recordupdatedAtstringnonoformat:datetimeNo description in lexicon yet.
tickets.atmosphere.checkInList5 fields
LocationFieldTypeRequiredNullableLimitsDescription
recordeventref:com.atproto.repo.strongRefyesnononeNo description in lexicon yet.
recordnamestringyesnominLength:1, maxLength:1000, maxGraphemes:100No description in lexicon yet.
recordarchivedbooleannonononeNo description in lexicon yet.
recordcreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
recordupdatedAtstringnonoformat:datetimeNo description in lexicon yet.
tickets.atmosphere.checkInTicket8 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
inputticketTokenstringyesnominLength:1, maxLength:4000No description in lexicon yet.
inputcheckInListIdstringnoyesminLength:1, maxLength:300No description in lexicon yet.
inputscannerDidstringnoyesformat:didNo description in lexicon yet.
inputmetadataunknownnonononeNo description in lexicon yet.
outputstatusstring<checked_in | already_checked_in | not_valid>yesnomaxLength:32No description in lexicon yet.
outputcheckedInAtstringnonoformat:datetimeNo description in lexicon yet.
outputticketref:tickets.atmosphere.defs#issuedTicketnonononeNo description in lexicon yet.
tickets.atmosphere.claimFreeTicket15 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
inputeventIdstringnonominLength:1, maxLength:300No description in lexicon yet.
inputeventUristringnonoformat:at-uriNo description in lexicon yet.
inputbuyerDidstringyesnoformat:didNo description in lexicon yet.
inputbuyerAssertionJwtstringyesnomaxLength:8192Required short-lived user service-auth JWT from buyerDid to ATM, scoped to tickets.atmosphere.claimFreeTicket.
inputcustomerEmailstringnoyesmaxLength:320No description in lexicon yet.
inputitemsarray<ref:tickets.atmosphere.defs#ticketHoldItemRequest>yesnominLength:1, maxLength:20No description in lexicon yet.
inputidempotencyKeystringnoyesminLength:1, maxLength:200No description in lexicon yet.
inputmetadataunknownnonononeNo description in lexicon yet.
outputclaimIdstringyesnomaxLength:300No description in lexicon yet.
outputholdIdstringyesnomaxLength:300No description in lexicon yet.
outputenvironmentstring<test | live>yesnomaxLength:16No description in lexicon yet.
outputitemsarray<ref:tickets.atmosphere.defs#ticketHoldItem>yesnominLength:1, maxLength:20No description in lexicon yet.
outputticketsarray<ref:tickets.atmosphere.defs#issuedTicketWithContext>yesnominLength:1, maxLength:50No description in lexicon yet.
outputreusedbooleannonononeNo description in lexicon yet.
tickets.atmosphere.createCapacityGroup8 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
inputorganizerDidstringyesnoformat:didNo description in lexicon yet.
inputeventref:tickets.atmosphere.defs#eventInputyesnononeNo description in lexicon yet.
inputnamestringyesnominLength:1, maxLength:200No description in lexicon yet.
inputtotalCapacityintegeryesnominimum:1, maximum:250000No description in lexicon yet.
inputmetadataunknownnonononeNo description in lexicon yet.
outputeventref:tickets.atmosphere.defs#eventSummaryyesnononeNo description in lexicon yet.
outputcapacityGroupref:tickets.atmosphere.defs#capacityGroupSummaryyesnononeNo description in lexicon yet.
tickets.atmosphere.createTicketHold20 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
inputeventIdstringnonominLength:1, maxLength:300No description in lexicon yet.
inputeventUristringnonoformat:at-uriNo description in lexicon yet.
inputbuyerDidstringnoyesformat:didNo description in lexicon yet.
inputbuyerAssertionJwtstringnoyesmaxLength:8192Optional short-lived user service-auth JWT from buyerDid to ATM.
inputcustomerEmailstringnoyesmaxLength:320No description in lexicon yet.
inputitemsarray<ref:tickets.atmosphere.defs#ticketHoldItemRequest>yesnominLength:1, maxLength:20No description in lexicon yet.
inputreturnUrlstringnonomaxLength:2000, format:uriNo description in lexicon yet.
inputcancelUrlstringnonomaxLength:2000, format:uriNo description in lexicon yet.
inputidempotencyKeystringnoyesminLength:1, maxLength:200No description in lexicon yet.
inputmetadataunknownnonononeNo description in lexicon yet.
outputholdIdstringyesnomaxLength:300No description in lexicon yet.
outputtokenstringyesnomaxLength:500No description in lexicon yet.
outputurlstringyesnomaxLength:2000, format:uriNo description in lexicon yet.
outputenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
outputexpiresAtstringyesnoformat:datetimeNo description in lexicon yet.
outputamountCentsintegeryesnominimum:0No description in lexicon yet.
outputcurrencystringyesnominLength:3, maxLength:3No description in lexicon yet.
outputitemsarray<ref:tickets.atmosphere.defs#ticketHoldItem>yesnominLength:1, maxLength:20No description in lexicon yet.
outputreusedbooleannonononeNo description in lexicon yet.
tickets.atmosphere.createTicketTier19 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
inputorganizerDidstringyesnoformat:didNo description in lexicon yet.
inputorganizerAssertionJwtstringnoyesmaxLength:8192Optional short-lived user service-auth JWT from organizerDid to ATM, scoped to tickets.atmosphere.createTicketTier.
inputeventref:tickets.atmosphere.defs#eventInputyesnononeNo description in lexicon yet.
inputtitlestringyesnominLength:1, maxLength:200No description in lexicon yet.
inputdescriptionstringnoyesmaxLength:5000No description in lexicon yet.
inputcurrencystringyesnominLength:3, maxLength:3No description in lexicon yet.
inputunitAmountintegeryesnominimum:0, maximum:2000000No description in lexicon yet.
inputmaxPerOrderintegernonominimum:1, maximum:50No description in lexicon yet.
inputsaleStartsAtstringnoyesformat:datetimeNo description in lexicon yet.
inputsaleEndsAtstringnoyesformat:datetimeNo description in lexicon yet.
inputtierRefref:com.atproto.repo.strongRefnoyesnoneNo description in lexicon yet.
inputproductRefref:com.atproto.repo.strongRefnoyesnoneNo description in lexicon yet.
inputpriceRefref:com.atproto.repo.strongRefnoyesnoneNo description in lexicon yet.
inputmetadataunknownnonononeNo description in lexicon yet.
inputquantityTotalintegeryesnominimum:1, maximum:250000No description in lexicon yet.
outputeventref:tickets.atmosphere.defs#eventSummaryyesnononeNo description in lexicon yet.
outputcapacityGroupref:tickets.atmosphere.defs#capacityGroupSummaryyesnononeNo description in lexicon yet.
outputtierref:tickets.atmosphere.defs#ticketTierSummaryyesnononeNo description in lexicon yet.
tickets.atmosphere.defs104 fields
LocationFieldTypeRequiredNullableLimitsDescription
def:priceAmountcurrencystringyesnominLength:3, maxLength:3No description in lexicon yet.
def:priceAmountunitAmountintegeryesnominimum:0No description in lexicon yet.
def:eventInputuristringyesnoformat:at-uriNo description in lexicon yet.
def:eventInputcidstringnonoformat:cidNo description in lexicon yet.
def:eventInputtitlestringyesnominLength:1, maxLength:3000, maxGraphemes:300No description in lexicon yet.
def:eventInputstartsAtstringnonoformat:datetimeNo description in lexicon yet.
def:eventInputimageUrlstringnonomaxLength:2000, format:uriNo description in lexicon yet.
def:ticketHoldItemRequesttierIdstringyesnominLength:1, maxLength:300No description in lexicon yet.
def:ticketHoldItemRequestquantityintegeryesnominimum:1, maximum:50No description in lexicon yet.
def:ticketHoldItemtierIdstringyesnomaxLength:300No description in lexicon yet.
def:ticketHoldItemtitlestringyesnomaxLength:300No description in lexicon yet.
def:ticketHoldItemquantityintegeryesnominimum:1, maximum:50No description in lexicon yet.
def:ticketHoldItemunitAmountintegeryesnominimum:0No description in lexicon yet.
def:ticketHoldItemcurrencystringyesnominLength:3, maxLength:3No description in lexicon yet.
def:ticketTierSummaryidstringyesnomaxLength:300No description in lexicon yet.
def:ticketTierSummaryeventIdstringyesnomaxLength:300No description in lexicon yet.
def:ticketTierSummarycapacityGroupIdstringyesnomaxLength:300No description in lexicon yet.
def:ticketTierSummarytitlestringyesnomaxLength:300No description in lexicon yet.
def:ticketTierSummarycurrencystringyesnominLength:3, maxLength:3No description in lexicon yet.
def:ticketTierSummaryunitAmountintegeryesnominimum:0No description in lexicon yet.
def:ticketTierSummarystatusstring<active | paused | archived>yesnomaxLength:32No description in lexicon yet.
def:capacityGroupSummaryidstringyesnomaxLength:300No description in lexicon yet.
def:capacityGroupSummaryeventIdstringnonomaxLength:300No description in lexicon yet.
def:capacityGroupSummarynamestringyesnomaxLength:300No description in lexicon yet.
def:capacityGroupSummarytotalCapacityintegeryesnominimum:1No description in lexicon yet.
def:capacityGroupSummarystatusstring<active | archived>yesnomaxLength:32No description in lexicon yet.
def:eventSummaryidstringyesnomaxLength:300No description in lexicon yet.
def:eventSummaryuristringyesnoformat:at-uriNo description in lexicon yet.
def:eventSummarytitlestringnonomaxLength:300No description in lexicon yet.
def:eventSummarystartsAtstringnonoformat:datetimeNo description in lexicon yet.
def:ticketAvailabilitytierIdstringyesnomaxLength:300No description in lexicon yet.
def:ticketAvailabilityeventIdstringnonomaxLength:300No description in lexicon yet.
def:ticketAvailabilitytitlestringyesnomaxLength:300No description in lexicon yet.
def:ticketAvailabilitydescriptionstringnonomaxLength:5000No description in lexicon yet.
def:ticketAvailabilitycurrencystringnonominLength:3, maxLength:3No description in lexicon yet.
def:ticketAvailabilityunitAmountintegernonominimum:0No description in lexicon yet.
def:ticketAvailabilitystatusstring<available | sold_out | not_on_sale | hidden | unavailable>yesnomaxLength:32No description in lexicon yet.
def:ticketAvailabilityavailableQuantityintegeryesnominimum:0No description in lexicon yet.
def:ticketAvailabilityheldQuantityintegernonominimum:0Quantity currently reserved by active holds.
def:ticketAvailabilitysoldQuantityintegernonominimum:0Quantity already issued/sold.
def:ticketAvailabilitymaxPerOrderintegeryesnominimum:1, maximum:50No description in lexicon yet.
def:ticketAvailabilitysaleStartsAtstringnonoformat:datetimeNo description in lexicon yet.
def:ticketAvailabilitysaleEndsAtstringnonoformat:datetimeNo description in lexicon yet.
def:ticketHoldCheckoutholdIdstringyesnomaxLength:300No description in lexicon yet.
def:ticketHoldCheckouttokenstringyesnomaxLength:500No description in lexicon yet.
def:ticketHoldCheckouturlstringyesnomaxLength:2000, format:uriNo description in lexicon yet.
def:ticketHoldCheckoutenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
def:ticketHoldCheckoutexpiresAtstringyesnoformat:datetimeNo description in lexicon yet.
def:ticketHoldCheckoutamountCentsintegeryesnominimum:0No description in lexicon yet.
def:ticketHoldCheckoutcurrencystringyesnominLength:3, maxLength:3No description in lexicon yet.
def:ticketHoldCheckoutitemsarray<ref:tickets.atmosphere.defs#ticketHoldItem>yesnominLength:1, maxLength:20No description in lexicon yet.
def:ticketHoldCheckoutreusedbooleannonononeNo description in lexicon yet.
def:ticketPresentationiconUrlstringyesnomaxLength:2000, format:uriNo description in lexicon yet.
def:ticketPresentationqrref:#ticketPresentationQryesnononeNo description in lexicon yet.
def:ticketPresentationappref:tickets.atmosphere.defs#brandyesnononeNo description in lexicon yet.
def:ticketPresentationorganizerref:tickets.atmosphere.defs#brandyesnononeNo description in lexicon yet.
def:ticketPresentationeventref:#ticketPresentationEventyesnononeNo description in lexicon yet.
def:ticketPresentationtierref:#ticketPresentationTieryesnononeNo description in lexicon yet.
def:branddidstringyesnoformat:didNo description in lexicon yet.
def:brandhandlestringnonomaxLength:300No description in lexicon yet.
def:brandnamestringyesnomaxLength:300No description in lexicon yet.
def:brandavatarUrlstringnonomaxLength:2000, format:uriNo description in lexicon yet.
def:issuedTicketidstringyesnomaxLength:300No description in lexicon yet.
def:issuedTicketeventIdstringyesnomaxLength:300No description in lexicon yet.
def:issuedTickettierIdstringyesnomaxLength:300No description in lexicon yet.
def:issuedTicketpaymentIdstringnonomaxLength:300No description in lexicon yet.
def:issuedTicketclaimIdstringnonomaxLength:300No description in lexicon yet.
def:issuedTicketenvironmentstring<test | live>yesnomaxLength:16No description in lexicon yet.
def:issuedTicketownerDidstringnonoformat:didNo description in lexicon yet.
def:issuedTicketstatusstring<active | voided | refunded>yesnomaxLength:32No description in lexicon yet.
def:issuedTicketticketNumberstringyesnomaxLength:300No description in lexicon yet.
def:issuedTicketscanTokenstringnonomaxLength:4000Private scan token returned only to authorized clients.
def:issuedTicketscanUrlstringnonomaxLength:2000, format:uriNo description in lexicon yet.
def:issuedTicketcreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
def:issuedTicketupdatedAtstringyesnoformat:datetimeNo description in lexicon yet.
def:issuedTicketWithContextidstringyesnomaxLength:300No description in lexicon yet.
def:issuedTicketWithContexteventIdstringyesnomaxLength:300No description in lexicon yet.
def:issuedTicketWithContexttierIdstringyesnomaxLength:300No description in lexicon yet.
def:issuedTicketWithContextpaymentIdstringnonomaxLength:300No description in lexicon yet.
def:issuedTicketWithContextclaimIdstringnonomaxLength:300No description in lexicon yet.
def:issuedTicketWithContextenvironmentstring<test | live>yesnomaxLength:16No description in lexicon yet.
def:issuedTicketWithContextownerDidstringnonoformat:didNo description in lexicon yet.
def:issuedTicketWithContextstatusstring<active | voided | refunded>yesnomaxLength:32No description in lexicon yet.
def:issuedTicketWithContextticketNumberstringyesnomaxLength:300No description in lexicon yet.
def:issuedTicketWithContextscanTokenstringnonomaxLength:4000No description in lexicon yet.
def:issuedTicketWithContextscanUrlstringnonomaxLength:2000, format:uriNo description in lexicon yet.
def:issuedTicketWithContextcreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
def:issuedTicketWithContextupdatedAtstringyesnoformat:datetimeNo description in lexicon yet.
def:issuedTicketWithContextpresentationref:tickets.atmosphere.defs#ticketPresentationnonononeNo description in lexicon yet.
def:issuedTicketWithContexteventref:tickets.atmosphere.defs#eventSummarynonononeNo description in lexicon yet.
def:issuedTicketWithContexttierref:tickets.atmosphere.defs#ticketTierSummarynonononeNo description in lexicon yet.
def:verificationResultvalidbooleanyesnononeNo description in lexicon yet.
def:verificationResultreasonstringnonomaxLength:100No description in lexicon yet.
def:verificationResultticketref:tickets.atmosphere.defs#issuedTicketnonononeNo description in lexicon yet.
def:verificationResultpresentationref:tickets.atmosphere.defs#ticketPresentationnonononeNo description in lexicon yet.
def:verificationResulteventref:tickets.atmosphere.defs#eventSummarynonononeNo description in lexicon yet.
def:verificationResulttierref:tickets.atmosphere.defs#ticketTierSummarynonononeNo description in lexicon yet.
def:ticketPresentationQrenabledbooleanyesnononeNo description in lexicon yet.
def:ticketPresentationQrlabelstringyesnomaxLength:100No description in lexicon yet.
def:ticketPresentationEventuristringyesnoformat:at-uriNo description in lexicon yet.
def:ticketPresentationEventtitlestringyesnomaxLength:300No description in lexicon yet.
def:ticketPresentationEventstartsAtstringnonoformat:datetimeNo description in lexicon yet.
def:ticketPresentationEventimageUrlstringnonomaxLength:2000, format:uriNo description in lexicon yet.
def:ticketPresentationTiertitlestringyesnomaxLength:300No description in lexicon yet.
tickets.atmosphere.getTicketAvailability2 fields
LocationFieldTypeRequiredNullableLimitsDescription
outputeventref:tickets.atmosphere.defs#eventSummarynonononeNo description in lexicon yet.
outputtiersarray<ref:tickets.atmosphere.defs#ticketAvailability>yesnomaxLength:250No description in lexicon yet.
tickets.atmosphere.listBuyerTickets2 fields
LocationFieldTypeRequiredNullableLimitsDescription
outputticketsarray<ref:tickets.atmosphere.defs#issuedTicketWithContext>yesnomaxLength:100No description in lexicon yet.
outputcursorstringnonomaxLength:512No description in lexicon yet.
tickets.atmosphere.listOrganizerTickets2 fields
LocationFieldTypeRequiredNullableLimitsDescription
outputticketsarray<ref:tickets.atmosphere.defs#issuedTicketWithContext>yesnomaxLength:250No description in lexicon yet.
outputcursorstringnonomaxLength:512No description in lexicon yet.
tickets.atmosphere.publicOffer9 fields
LocationFieldTypeRequiredNullableLimitsDescription
recordeventref:com.atproto.repo.strongRefyesnononeNo description in lexicon yet.
recordtiersarray<ref:com.atproto.repo.strongRef>yesnononeNo description in lexicon yet.
recordtitlestringnonomaxLength:1000, maxGraphemes:100No description in lexicon yet.
recorddescriptionstringnonomaxLength:10000, maxGraphemes:1000No description in lexicon yet.
recordstartsAtstringnonoformat:datetimeNo description in lexicon yet.
recordendsAtstringnonoformat:datetimeNo description in lexicon yet.
recordarchivedbooleannonononeNo description in lexicon yet.
recordcreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
recordupdatedAtstringnonoformat:datetimeNo description in lexicon yet.
tickets.atmosphere.releaseTicketHold6 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
inputholdIdstringyesnominLength:1, maxLength:300No description in lexicon yet.
inputreasonstringnonomaxLength:200No description in lexicon yet.
outputholdref:#holdyesnononeNo description in lexicon yet.
def:holdidstringyesnomaxLength:300No description in lexicon yet.
def:holdstatusstring<released | expired | failed | completed>yesnomaxLength:32No description in lexicon yet.
tickets.atmosphere.ticketTier13 fields
LocationFieldTypeRequiredNullableLimitsDescription
recordeventref:com.atproto.repo.strongRefyesnononeNo description in lexicon yet.
recordtitlestringyesnominLength:1, maxLength:1000, maxGraphemes:100No description in lexicon yet.
recorddescriptionstringnonomaxLength:10000, maxGraphemes:1000No description in lexicon yet.
recordcurrencystringyesnominLength:3, maxLength:3No description in lexicon yet.
recordunitAmountintegeryesnominimum:0No description in lexicon yet.
recordcapacityGroupref:com.atproto.repo.strongRefnonononeNo description in lexicon yet.
recordproductref:com.atproto.repo.strongRefnonononeNo description in lexicon yet.
recordpriceref:com.atproto.repo.strongRefnonononeNo description in lexicon yet.
recordsaleStartsAtstringnonoformat:datetimeNo description in lexicon yet.
recordsaleEndsAtstringnonoformat:datetimeNo description in lexicon yet.
recordarchivedbooleannonononeNo description in lexicon yet.
recordcreatedAtstringyesnoformat:datetimeNo description in lexicon yet.
recordupdatedAtstringnonoformat:datetimeNo description in lexicon yet.
tickets.atmosphere.updateCapacityGroup7 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
inputcapacityGroupIdstringyesnominLength:1, maxLength:300No description in lexicon yet.
inputnamestringnonominLength:1, maxLength:200No description in lexicon yet.
inputtotalCapacityintegernonominimum:1, maximum:250000No description in lexicon yet.
inputstatusstring<active | archived>nonomaxLength:32No description in lexicon yet.
inputmetadataunknownnonononeNo description in lexicon yet.
outputcapacityGroupref:tickets.atmosphere.defs#capacityGroupSummaryyesnononeNo description in lexicon yet.
tickets.atmosphere.updateTicketTier15 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
inputtierIdstringyesnominLength:1, maxLength:300No description in lexicon yet.
inputtitlestringnonominLength:1, maxLength:200No description in lexicon yet.
inputdescriptionstringnoyesmaxLength:5000No description in lexicon yet.
inputcurrencystringnonominLength:3, maxLength:3No description in lexicon yet.
inputunitAmountintegernonominimum:0, maximum:2000000No description in lexicon yet.
inputmaxPerOrderintegernonominimum:1, maximum:50No description in lexicon yet.
inputsaleStartsAtstringnoyesformat:datetimeNo description in lexicon yet.
inputsaleEndsAtstringnoyesformat:datetimeNo description in lexicon yet.
inputtierRefref:com.atproto.repo.strongRefnoyesnoneNo description in lexicon yet.
inputproductRefref:com.atproto.repo.strongRefnoyesnoneNo description in lexicon yet.
inputpriceRefref:com.atproto.repo.strongRefnoyesnoneNo description in lexicon yet.
inputmetadataunknownnonononeNo description in lexicon yet.
inputstatusstring<active | paused | archived>nonomaxLength:32No description in lexicon yet.
outputtierref:tickets.atmosphere.defs#ticketTierSummaryyesnononeNo description in lexicon yet.
tickets.atmosphere.verifyTicket8 fields
LocationFieldTypeRequiredNullableLimitsDescription
inputenvironmentstring<test | live>nonomaxLength:16No description in lexicon yet.
inputticketTokenstringyesnominLength:1, maxLength:4000No description in lexicon yet.
outputvalidbooleanyesnononeNo description in lexicon yet.
outputreasonstringnonomaxLength:100No description in lexicon yet.
outputticketref:tickets.atmosphere.defs#issuedTicketnonononeNo description in lexicon yet.
outputpresentationref:tickets.atmosphere.defs#ticketPresentationnonononeNo description in lexicon yet.
outputeventref:tickets.atmosphere.defs#eventSummarynonononeNo description in lexicon yet.
outputtierref:tickets.atmosphere.defs#ticketTierSummarynonononeNo 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:check

Public review artifacts

Use this page alongside the lexicon review bundle when asking the AT Protocol community to review contract shape. The human review page explains design goals; this generated page keeps the full method and record index honest.

Human review

Use the lexicon review page for design rationale and open questions.

Generated index

Use this page to verify every current contract and lifecycle label.

Tickets reference

Use atmosphere.tickets docs for ticket-specific integration flows.

Generated reference - Atmosphere Money Docs