Lexicon Garden

com.atiproto.payment.subscription.create

Create a subscription to a user. Returns a one-off cart with checkout URL.

Repository @atiproto.com did:plc:4x5dcv6u4wlkjcssto7f22nu namespace authority
Details · procedure
Kindprocedure
Authoritysubscription.payment.atiproto.com
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

amount

integer

Custom amount in cents (if pay-as-you-want enabled)

cartUri

string · at-uri

AT-URI of an existing cart to add this subscription to. If omitted, a new cart is created.

currency

requiredstring

ISO 4217 currency code

  • maxLength: 3

interval

requiredstring

Billing interval

  • maxLength: 64
  • enum: monthly | yearly

isPrivate

boolean

If true, the recipient (subject) is stored only in atiproto's private database and is omitted from the PDS subscription record.

redirectUrl

string · uri

URL to redirect to after checkout completes

subject

requiredstring · did

DID of the user to subscribe to

workflow

ref

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

Reference

Output

application/json

cart

ref

The created cart record (status: open)

Reference

cartUri

string · at-uri

URI of the cart record in PDS

checkoutUrl

string · uri

Checkout URL hosted by atiproto

subscription

ref

The created subscription record (status: pending)

Reference

subscriptionUri

string · at-uri

URI of the subscription record in PDS

workflow

ref

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

Reference

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.