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

main procedure

Cancel an active subscription

Input

Encodingapplication/json

subscriptionUri stringat-uri Required

AT-URI of the subscription to cancel

workflow refcom.atiproto.actions#inboundWorkflow Optional

Workflow callback envelope. Present on agent-driven callbacks; absent on initial calls.

Output

Encodingapplication/json

accessUntil stringdatetime Optional

Timestamp when access expires

subscription refcom.atiproto.subscription#view Optional

Updated subscription record

subscriptionUri stringat-uri Optional

URI of the updated subscription record

workflow refcom.atiproto.actions#outboundWorkflow Optional

Workflow envelope. When present, the agent runs the actions and calls back. When absent, this is the final native result.

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://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "subscriptionUri"
      ],
      "properties": {
        "workflow": {
          "ref": "com.atiproto.actions#inboundWorkflow",
          "type": "ref",
          "description": "Workflow callback envelope. Present on agent-driven callbacks; absent on initial calls."
        },
        "subscriptionUri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the subscription to cancel"
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "type": "object",
      "properties": {
        "workflow": {
          "ref": "com.atiproto.actions#outboundWorkflow",
          "type": "ref",
          "description": "Workflow envelope. When present, the agent runs the actions and calls back. When absent, this is the final native result."
        },
        "accessUntil": {
          "type": "string",
          "format": "datetime",
          "description": "Timestamp when access expires"
        },
        "subscription": {
          "ref": "com.atiproto.subscription#view",
          "type": "ref",
          "description": "Updated subscription record"
        },
        "subscriptionUri": {
          "type": "string",
          "format": "at-uri",
          "description": "URI of the updated subscription record"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Cancel an active subscription"
}