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 | Public or app-scoped read | 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.app.requestRecipientApproval | procedure | /xrpc/money.atmosphere.app.requestRecipientApproval | App service-auth | beta draft | Request creator approval for an app to accept ATM payments for that recipient. | |
| 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 | App service-auth | beta draft | Create a private ATM billing migration review batch from a Ko-fi membership export. | |
| 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.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 | App service-auth | beta draft | Private app callback that links an ATM product record to the app surface responsible for fulfillment. | |
| 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.receive | procedure | /xrpc/money.atmosphere.event.receive | App service-auth | beta draft | Optional app-implemented XRPC receiver for ATM outbound events. | |
| 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.cancelSubscription | procedure | /xrpc/money.atmosphere.payment.cancelSubscription | App service-auth | beta draft | Cancel a subscription on behalf of the authenticated payer. | |
| money.atmosphere.payment.declineRecord | procedure | /xrpc/money.atmosphere.payment.declineRecord | App service-auth | beta draft | Signal that the originating app cannot write a delegated record. | |
| money.atmosphere.payment.listPendingRecords | query | /xrpc/money.atmosphere.payment.listPendingRecords | Public or app-scoped read | beta draft | List pending payer/creator records the originating app may upgrade. | |
| money.atmosphere.payment.listSubscriptions | query | /xrpc/money.atmosphere.payment.listSubscriptions | Public or app-scoped read | beta draft | List active subscriptions for the authenticated payer. | |
| money.atmosphere.payment.registerCreatorProof | procedure | /xrpc/money.atmosphere.payment.registerCreatorProof | App 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 | App service-auth | beta draft | Register a payer record URI written by the originating app on the payer's PDS via OAuth. | |
| 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. |
ATM money fields
money.atmosphere.actor.getPayoutStatus17 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| output | status | string | yes | no | maxLength:64 | No description in lexicon yet. |
| 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 | none | 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 | none | 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.getProfile4 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| 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.app.requestRecipientApproval25 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:16 | No description in lexicon yet. |
| input | paymentTypes | array<string<tip | subscribe | shop | commission | ticket>> | yes | no | minLength:1, maxLength:5 | 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 | yes | none | No description in lexicon yet. |
| input | requestReason | string | no | yes | maxLength:3000, maxGraphemes:300 | No description in lexicon yet. |
| input | setupReturnUrl | string | no | yes | format:uri | No description in lexicon yet. |
| 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 | yes | no | format:uri | No description in lexicon yet. |
| output | paymentTypes | array<string<tip | subscribe | shop | commission | ticket>> | yes | no | none | No description in lexicon yet. |
| output | feeShareBps | integer | yes | no | minimum:0, maximum:10000 | No description in lexicon yet. |
| output | materialChangeReasons | array<string> | 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:publicRecordPaymentPolicy | payerCanChoose | boolean | no | no | none | No description in lexicon yet. |
| def:publicRecordPaymentPolicy | coupleInCheckout | boolean | no | no | none | No description in lexicon yet. |
| 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: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.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.requestKofiMigrationBatch38 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:16 | No description in lexicon yet. |
| input | requestedCutoverAt | string | no | yes | 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 | batch | ref:#batch | yes | no | none | No description in lexicon yet. |
| output | dashboardUrl | string | yes | 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> | 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 | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | paypalRows | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | unknownPaymentMethodRows | integer | yes | 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 | totalAmountCents | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:previewSummary | currencies | array<string> | yes | no | none | 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 | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | paypalCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | unknownPaymentMethodCount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | totalAmountCents | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:tierSummary | currencies | array<string> | yes | no | none | 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:16 | No description in lexicon yet. |
| def:batch | importSource | string<kofi> | 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 | appDid | string | no | yes | format:did | No description in lexicon yet. |
| def:batch | requestedCutoverAt | string | no | yes | format:datetime | No description in lexicon yet. |
money.atmosphere.catalog.getProduct33 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| 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 | yes | no | minimum:1 | No description in lexicon yet. |
| def:catalogPrice | customUnitAmount | ref:#catalogPriceCustomUnitAmount | no | yes | 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 | yes | 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 | yes | none | No description in lexicon yet. |
| def:catalogProduct | kind | string<physical | digital | commission | membership | service | ticket | 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 | yes | 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 | integer | yes | no | none | When the AppView indexed this product, as Unix epoch milliseconds. |
| 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:1 | 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 | yes | no | minimum:1, maximum:36 | No description in lexicon yet. |
money.atmosphere.catalog.listProducts34 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| output | products | array<ref:#catalogProduct> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:512 | 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 | yes | no | minimum:1 | No description in lexicon yet. |
| def:catalogPrice | customUnitAmount | ref:#catalogPriceCustomUnitAmount | no | yes | 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 | yes | 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 | yes | none | No description in lexicon yet. |
| def:catalogProduct | kind | string<physical | digital | commission | membership | service | ticket | 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 | yes | 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 | integer | yes | no | none | When the AppView indexed this product, as Unix epoch milliseconds. |
| 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:1 | 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 | yes | no | minimum:1, maximum:36 | No description in lexicon yet. |
money.atmosphere.catalog.registerAppLink14 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 | yes | none | No description in lexicon yet. |
| input | fulfillmentUrl | string | no | yes | format:uri | No description in lexicon yet. |
| input | appLabel | string | no | yes | maxLength:800, maxGraphemes:80 | No description in lexicon yet. |
| input | appUrl | string | no | yes | format:uri | No description in lexicon yet. |
| input | appIconUrl | string | no | yes | format:uri | No description in lexicon yet. |
| 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.discount15 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, maximum:36 | 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 | none | ATM product URIs this discount can apply to. |
| def:appliesTo | priceUris | array<string> | no | no | none | ATM price 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.receive159 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | id | string | yes | no | none | ATM delivery id. |
| input | type | ref:#eventType | yes | no | none | ATM event type, such as payment.completed or tickets.issued. |
| input | created | integer | yes | no | none | Unix timestamp, in seconds, when ATM built the event envelope. |
| input | apiVersion | string | yes | no | none | ATM outbound event envelope version. |
| input | environment | string<test | live> | no | no | none | 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 | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:payment | amountCents | 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:invoice | id | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:invoice | subscriptionId | string | no | no | maxLength:256 | No description in lexicon yet. |
| def:invoice | amount | string | no | no | maxLength:64 | No description in lexicon yet. |
| def:invoice | amountCents | integer | no | no | none | No description in lexicon yet. |
| def:invoice | currency | string | no | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:invoice | firstInvoice | boolean | no | no | none | No description in lexicon yet. |
| def:subscription | id | string | yes | no | maxLength:256 | No description in lexicon yet. |
| def:subscription | status | string | no | no | maxLength:64 | No description in lexicon yet. |
| 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 | amountCents | 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 | unitAmountCents | 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: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:16 | 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 | 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 | cid | string | no | no | format:cid | No description in lexicon yet. |
| def:attestation | mode | string | no | no | maxLength:64 | 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: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 | amount | integer | no | no | minimum:0 | No description in lexicon yet. |
| 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:paymentDisputed | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| 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: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: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 | priorAmountCents | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:subscriptionUpdated | amountCents | 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:subscriptionCancelled | subscription | ref:#subscription | yes | no | none | No description in lexicon yet. |
| def:subscriptionCancelled | payment | ref:#payment | yes | no | none | No description in lexicon yet. |
| def:subscriptionCancelled | cancelledAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:subscriptionCancelled | cancelledBy | ref:#actorSummary | no | no | none | No description in lexicon yet. |
| def:subscriptionCancelled | reason | string | no | no | maxLength:512 | No description in lexicon yet. |
| 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 | 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:attestationUpdated | paymentId | string | yes | no | maxLength:256 | No description in lexicon yet. |
| 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: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:attestationPolicy | appRecord | string<public | private> | no | no | none | No description in lexicon yet. |
| def:attestationPolicy | attestation | string<public | private> | no | no | none | 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.cancelSubscription5 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | paymentId | string | yes | no | maxLength:128 | No description in lexicon yet. |
| input | reason | string | no | no | maxLength:256 | No description in lexicon yet. |
| output | paymentId | string | yes | no | maxLength:128 | No description in lexicon yet. |
| output | status | string | yes | no | maxLength:64 | No description in lexicon yet. |
| output | cancelledAt | 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:128 | 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:128 | 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.listPendingRecords10 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| output | records | array<ref:#records> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:records | paymentId | string | yes | no | maxLength:128 | No description in lexicon yet. |
| def:records | recordType | string<payer | creator> | yes | no | maxLength:16 | No description in lexicon yet. |
| def:records | payerDid | string | no | no | format:did | No description in lexicon yet. |
| def:records | recipientDid | string | no | no | format:did | No description in lexicon yet. |
| def:records | collection | string | no | no | format:nsid | No description in lexicon yet. |
| def:records | canonicalRecord | union | no | no | none | No description in lexicon yet. |
| def:records | attestationCid | string | no | no | format:cid | No description in lexicon yet. |
| def:records | expectedCid | string | yes | no | format:cid | No description in lexicon yet. |
money.atmosphere.payment.listSubscriptions13 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| output | subscriptions | array<ref:#subscription> | yes | no | none | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:512 | No description in lexicon yet. |
| def:subscription | paymentId | string | yes | no | maxLength:128 | No description in lexicon yet. |
| 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 | amountCents | 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<month | quarter | year> | no | no | maxLength:16 | No description in lexicon yet. |
| def:subscription | status | string | yes | no | maxLength:64 | No description in lexicon yet. |
| def:subscription | metadata | unknown | no | no | none | Sanitized public display hints only. |
| def:subscription | entitlements | array<ref:com.atproto.repo.strongRef> | no | no | none | No description in lexicon yet. |
| def:subscription | listing | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| def:subscription | createdAt | string | yes | no | format:datetime | No description in lexicon yet. |
money.atmosphere.payment.registerCreatorProof7 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| input | paymentId | string | yes | no | maxLength:128 | 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:128 | 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:128 | No description in lexicon yet. |
| input | payerProofUri | string | yes | no | format:at-uri | No description in lexicon yet. |
| input | payerProofCid | string | yes | no | format:cid | No description in lexicon yet. |
| output | paymentId | string | yes | no | maxLength:128 | No description in lexicon yet. |
| output | payerProofUri | string | yes | no | format:at-uri | No description in lexicon yet. |
| output | payerProofCid | string | yes | no | format:cid | No description in lexicon yet. |
| output | alreadyRegistered | boolean | no | no | none | No description in lexicon yet. |
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 | yes | no | minimum:1 | No description in lexicon yet. |
| 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 | string | yes | no | maxLength:32 | Inclusive upper bound for this tier, or inf for the final tier. |
| 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:1 | 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 | yes | no | minimum:1, maximum:36 | No description in lexicon yet. |
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 | 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 | No description in lexicon yet. |
| 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 | uri | string | yes | no | format:uri | No description in lexicon yet. |
| def:image | alt | string | no | no | maxLength:3000, maxGraphemes:300 | 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.lookup1 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| 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.status2 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| 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.archiveTicketTier | procedure | /xrpc/tickets.atmosphere.archiveTicketTier | App service-auth | beta draft | Archive an app-scoped ATM Tickets tier. | |
| tickets.atmosphere.capacityGroup | record | PDS | PDS record | beta draft | Public capacity-group label 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 | App service-auth | beta draft | Verify and check in a private ATM Tickets scan token. | |
| tickets.atmosphere.claimFreeTicket | procedure | /xrpc/tickets.atmosphere.claimFreeTicket | App service-auth | beta draft | Atomically claim zero-price scarce tickets for a verified buyer without checkout redirect. | |
| tickets.atmosphere.createCapacityGroup | procedure | /xrpc/tickets.atmosphere.createCapacityGroup | App service-auth | beta draft | Create a private capacity group for an app-scoped ticketed event. | |
| tickets.atmosphere.createTicketHold | procedure | /xrpc/tickets.atmosphere.createTicketHold | App 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 app-scoped 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 | Public or app-scoped read | beta draft | Read app-scoped ticket availability derived from private ATM holds and issued tickets. | |
| tickets.atmosphere.listBuyerTickets | query | /xrpc/tickets.atmosphere.listBuyerTickets | Public or app-scoped read | beta draft | List app-scoped issued tickets for a buyer or payment. | |
| tickets.atmosphere.listOrganizerTickets | query | /xrpc/tickets.atmosphere.listOrganizerTickets | Public or app-scoped read | beta draft | List app-scoped issued tickets for an organizer or event. | |
| tickets.atmosphere.publicOffer | record | PDS | PDS record | beta draft | Public offer grouping for event tickets. | |
| tickets.atmosphere.releaseTicketHold | procedure | /xrpc/tickets.atmosphere.releaseTicketHold | App service-auth | beta draft | Release an active ticket hold before checkout completes. | |
| tickets.atmosphere.ticketTier | record | PDS | PDS record | beta draft | Public ticket tier metadata for an AT Protocol event. | |
| tickets.atmosphere.updateCapacityGroup | procedure | /xrpc/tickets.atmosphere.updateCapacityGroup | App service-auth | beta draft | Update a private capacity group for an app-scoped ticketed event. | |
| tickets.atmosphere.updateTicketTier | procedure | /xrpc/tickets.atmosphere.updateTicketTier | App service-auth | beta draft | Update app-scoped ATM Tickets tier metadata. | |
| tickets.atmosphere.verifyTicket | procedure | /xrpc/tickets.atmosphere.verifyTicket | App service-auth | beta draft | Verify a private ATM Tickets scan token without mutating check-in state. |
Tickets fields
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.capacityGroup5 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.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 | yes | minLength:1, maxLength:300 | No description in lexicon yet. |
| input | scannerDid | string | no | yes | format:did | No description in lexicon yet. |
| 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 | yes | 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 | yes | 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:50 | No description in lexicon yet. |
| output | reused | boolean | no | no | none | No description in lexicon yet. |
tickets.atmosphere.createCapacityGroup8 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 | event | ref:tickets.atmosphere.defs#eventInput | yes | no | none | No description in lexicon yet. |
| input | name | string | yes | no | minLength:1, maxLength:200 | 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.createTicketHold20 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 | yes | format:did | No description in lexicon yet. |
| input | buyerAssertionJwt | string | no | yes | maxLength:8192 | Optional short-lived user service-auth JWT from buyerDid to ATM. |
| input | customerEmail | string | no | yes | 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 | 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 | yes | 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 | amountCents | integer | yes | no | minimum:0 | No description in lexicon yet. |
| output | currency | string | yes | no | minLength:3, maxLength:3 | 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 | 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 | yes | 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:200 | No description in lexicon yet. |
| input | description | string | no | yes | maxLength:5000 | No description in lexicon yet. |
| input | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| input | unitAmount | integer | yes | no | minimum:0, maximum:2000000 | No description in lexicon yet. |
| 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 | 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.defs104 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| def:priceAmount | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:priceAmount | unitAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| 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 | 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 | No description in lexicon yet. |
| 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: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 | 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: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 | No description in lexicon yet. |
| 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:ticketHoldCheckout | holdId | string | yes | no | maxLength:300 | No description in lexicon yet. |
| def:ticketHoldCheckout | token | string | yes | no | maxLength:500 | No description in lexicon yet. |
| def:ticketHoldCheckout | url | string | yes | no | maxLength:2000, format:uri | No description in lexicon yet. |
| def:ticketHoldCheckout | environment | string<test | live> | no | no | maxLength:16 | No description in lexicon yet. |
| def:ticketHoldCheckout | expiresAt | string | yes | no | format:datetime | No description in lexicon yet. |
| def:ticketHoldCheckout | amountCents | integer | yes | no | minimum:0 | No description in lexicon yet. |
| def:ticketHoldCheckout | currency | string | yes | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| def:ticketHoldCheckout | items | array<ref:tickets.atmosphere.defs#ticketHoldItem> | yes | no | minLength:1, maxLength:20 | No description in lexicon yet. |
| def:ticketHoldCheckout | reused | boolean | no | no | none | No description in lexicon yet. |
| def:ticketPresentation | iconUrl | string | yes | no | maxLength:2000, format:uri | No description in lexicon yet. |
| 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 | maxLength:300 | 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 | 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 | 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:verificationResult | valid | boolean | yes | no | none | No description in lexicon yet. |
| def:verificationResult | reason | string | no | no | maxLength:100 | No description in lexicon yet. |
| def:verificationResult | ticket | ref:tickets.atmosphere.defs#issuedTicket | no | no | none | No description in lexicon yet. |
| def:verificationResult | presentation | ref:tickets.atmosphere.defs#ticketPresentation | no | no | none | No description in lexicon yet. |
| def:verificationResult | event | ref:tickets.atmosphere.defs#eventSummary | no | no | none | No description in lexicon yet. |
| def:verificationResult | 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.getTicketAvailability2 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| 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.listBuyerTickets2 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| output | tickets | array<ref:tickets.atmosphere.defs#issuedTicketWithContext> | yes | no | maxLength:100 | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:512 | No description in lexicon yet. |
tickets.atmosphere.listOrganizerTickets2 fields
| Location | Field | Type | Required | Nullable | Limits | Description |
|---|---|---|---|---|---|---|
| output | tickets | array<ref:tickets.atmosphere.defs#issuedTicketWithContext> | yes | no | maxLength:250 | No description in lexicon yet. |
| output | cursor | string | no | no | maxLength:512 | 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 | none | 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.ticketTier13 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 | No description in lexicon yet. |
| record | unitAmount | integer | yes | no | minimum:0 | No description in lexicon yet. |
| record | capacityGroup | ref:com.atproto.repo.strongRef | no | no | none | No description in lexicon yet. |
| 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:200 | 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.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:200 | No description in lexicon yet. |
| input | description | string | no | yes | maxLength:5000 | No description in lexicon yet. |
| input | currency | string | no | no | minLength:3, maxLength:3 | No description in lexicon yet. |
| input | unitAmount | integer | no | no | minimum:0, maximum:2000000 | No description in lexicon yet. |
| 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.