com.atiproto.recipient.payment.subscription.validate Documentation (EN)

main query

Validate that a sender has an active, Stripe-verified subscription to the authenticated user (as the recipient/subject). Looks up by subscriptionUri (a specific subscription record) or sender (subscriber DID). These are mutually exclusive; subscriptionUri takes precedence.

Parameters

amount integer Optional

Expected subscription amount in cents. If omitted, only checks that a subscription exists.

sender string did Optional

DID of the subscriber. Ignored if subscriptionUri is provided.

subscriptionUri string at-uri Optional

AT-URI of a specific subscription record. Takes precedence over sender.

Output

Encodingapplication/json

amount integer Optional

Subscription amount in cents

currency string Optional

Currency of the subscription

reason string Optional

If invalid, reason for rejection

valid boolean Required

Whether a sender has an active, verified subscription to the authed recipient

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

amount Expected subscription amount in cents. If omitted, only checks that a subscription exists.

sender DID of the subscriber. Ignored if subscriptionUri is provided.

subscriptionUri AT-URI of a specific subscription record. Takes precedence over sender.

View raw schema

{
  "description": "Validate that a sender has an active, Stripe-verified subscription to the authenticated user (as the recipient/subject). Looks up by subscriptionUri (a specific subscription record) or sender (subscriber DID). These are mutually exclusive; subscriptionUri takes precedence.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "amount": {
          "description": "Subscription amount in cents",
          "type": "integer"
        },
        "currency": {
          "description": "Currency of the subscription",
          "maxLength": 3,
          "type": "string"
        },
        "reason": {
          "description": "If invalid, reason for rejection",
          "maxLength": 1024,
          "type": "string"
        },
        "valid": {
          "description": "Whether a sender has an active, verified subscription to the authed recipient",
          "type": "boolean"
        }
      },
      "required": [
        "valid"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "amount": {
        "description": "Expected subscription amount in cents. If omitted, only checks that a subscription exists.",
        "type": "integer"
      },
      "sender": {
        "description": "DID of the subscriber. Ignored if subscriptionUri is provided.",
        "format": "did",
        "type": "string"
      },
      "subscriptionUri": {
        "description": "AT-URI of a specific subscription record. Takes precedence over sender.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}