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

main query

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

Parameters

subject string did Optional

DID of the user being subscribed to. Ignored if uri is provided.

uri string at-uri Optional

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

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

subject DID of the user being subscribed to. Ignored if uri is provided.

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

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 subject."
      },
      "subject": {
        "type": "string",
        "format": "did",
        "description": "DID of the user being subscribed to. Ignored if uri is provided."
      }
    }
  },
  "description": "Get a specific subscription sent by the authenticated user. Looks up by subscription record uri or subject (recipient) DID. These are mutually exclusive; uri takes precedence."
}