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

main query

Get a specific subscription received by the authenticated user (as the recipient/subject). Looks up by subscription record uri or sender DID. These are mutually exclusive; uri takes precedence.

Parameters

sender string did Optional

DID of the subscriber. Ignored if uri is provided.

uri string at-uri Optional

AT-URI of the subscription record. Takes precedence over sender.

Output

Encodingapplication/json

subscription refcom.atiproto.subscription#view Required

The subscription record data

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

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

uri AT-URI of the subscription record. Takes precedence over sender.

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "subscription"
      ],
      "properties": {
        "subscription": {
          "ref": "com.atiproto.subscription#view",
          "type": "ref",
          "description": "The subscription record data"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "uri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the subscription record. Takes precedence over sender."
      },
      "sender": {
        "type": "string",
        "format": "did",
        "description": "DID of the subscriber. Ignored if uri is provided."
      }
    }
  },
  "description": "Get a specific subscription received by the authenticated user (as the recipient/subject). Looks up by subscription record uri or sender DID. These are mutually exclusive; uri takes precedence."
}