com.atiproto.recipient.payment.cart.get

atiproto.com

Documentation

Get a cart that pays the authenticated user — a cart whose items target this user. Look up by cart URI, by a contained item record URI, or by a contained subscription record URI. One of `uri`, `itemUri`, or `subscriptionUri` is required.

main query

Get a cart that pays the authenticated user — a cart whose items target this user. Look up by cart URI, by a contained item record URI, or by a contained subscription record URI. One of `uri`, `itemUri`, or `subscriptionUri` is required.

Parameters

itemUri string at-uri Optional

AT-URI of an item record received by the authed user. Returns the cart that contains this item. Ignored if uri is provided.

subscriptionUri string at-uri Optional

AT-URI of a subscription record received by the authed user. Returns the cart that contains this subscription. Ignored if uri or itemUri is provided.

uri string at-uri Optional

AT-URI of the cart record. Takes precedence over itemUri and subscriptionUri.

Output

Encodingapplication/json
cid stringcid Optional

Cart record CID

items array Required

Resolved item records in this cart that target the authed user

subscriptions array Required

Resolved subscription records in this cart that target the authed user

uri stringat-uri Required

Cart record URI

Try It

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

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
AT-URI of an item record received by the authed user. Returns the cart that contains this item. Ignored if uri is provided.
AT-URI of a subscription record received by the authed user. Returns the cart that contains this subscription. Ignored if uri or itemUri is provided.
AT-URI of the cart record. Takes precedence over itemUri and subscriptionUri.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cart",
        "items",
        "subscriptions"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "Cart record CID"
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "Cart record URI"
        },
        "cart": {
          "ref": "com.atiproto.cart#view",
          "type": "ref",
          "description": "The cart record data"
        },
        "items": {
          "type": "array",
          "items": {
            "ref": "com.atiproto.item#view",
            "type": "ref"
          },
          "description": "Resolved item records in this cart that target the authed user"
        },
        "subscriptions": {
          "type": "array",
          "items": {
            "ref": "com.atiproto.subscription#view",
            "type": "ref"
          },
          "description": "Resolved subscription records in this cart that target the authed user"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "uri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the cart record. Takes precedence over itemUri and subscriptionUri."
      },
      "itemUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of an item record received by the authed user. Returns the cart that contains this item. Ignored if uri is provided."
      },
      "subscriptionUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of a subscription record received by the authed user. Returns the cart that contains this subscription. Ignored if uri or itemUri is provided."
      }
    }
  },
  "description": "Get a cart that pays the authenticated user — a cart whose items target this user. Look up by cart URI, by a contained item record URI, or by a contained subscription record URI. One of `uri`, `itemUri`, or `subscriptionUri` is required."
}

Lexicon Garden

@