net.wireservice.payment Documentation (EN)

main record

A single payment or donation, stored in the publication's business space.

Record Key tid Timestamp-based ID

Properties

amount integer Required

Amount in the currency's minor unit (e.g., cents).

minimum: 0

currency string Required

ISO 4217 currency code, lowercase (e.g., 'usd').

maxLength: 3 bytes

paidAt string datetime Required

An RFC 3339 formatted timestamp.

plan string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

reader string uri Required

URI of the net.wireservice.reader record.

status string Required

No description available.

maxLength: 64 bytes

Known values: succeeded, refunded

stripeId string Optional

Stripe invoice or payment intent id.

maxLength: 256 bytes

View raw schema

{
  "description": "A single payment or donation, stored in the publication's business space.",
  "key": "tid",
  "record": {
    "properties": {
      "amount": {
        "description": "Amount in the currency's minor unit (e.g., cents).",
        "minimum": 0,
        "type": "integer"
      },
      "currency": {
        "description": "ISO 4217 currency code, lowercase (e.g., 'usd').",
        "maxLength": 3,
        "type": "string"
      },
      "paidAt": {
        "format": "datetime",
        "type": "string"
      },
      "plan": {
        "format": "at-uri",
        "type": "string"
      },
      "reader": {
        "description": "URI of the net.wireservice.reader record.",
        "format": "uri",
        "type": "string"
      },
      "status": {
        "knownValues": [
          "succeeded",
          "refunded"
        ],
        "maxLength": 64,
        "type": "string"
      },
      "stripeId": {
        "description": "Stripe invoice or payment intent id.",
        "maxLength": 256,
        "type": "string"
      }
    },
    "required": [
      "reader",
      "amount",
      "currency",
      "status",
      "paidAt"
    ],
    "type": "object"
  },
  "type": "record"
}