net.wireservice.entitlement

wireservice.net

Documentation

A reader's access grant, stored in the publication's business space. Authoritative: the processor's state only proposes changes to it. Grants the plan's spaces plus any listed here; at least one of plan or spaces should be set.

main record

A reader's access grant, stored in the publication's business space. Authoritative: the processor's state only proposes changes to it. Grants the plan's spaces plus any listed here; at least one of plan or spaces should be set.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

expiresAt string datetime Optional

When access ends. Paid entitlements set this to the end of the paid period plus a grace window and extend it on each payment. Omit for open-ended grants.

note string Optional

Why a manual grant exists (e.g., 'Press pass', 'University site license').

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
plan string at-uri Optional

AT URI of the net.wireservice.plan this entitlement is for.

reader string uri Required

URI of the net.wireservice.reader record.

source string Required

Who manages this entitlement. Processor events never modify 'manual' entitlements.

maxLength: 64 bytes
Known values: stripe, manual
spaces array of string space-ref Optional

Additional spaces granted, beyond the plan's.

stripeSubscriptionId string Optional

No description available.

maxLength: 256 bytes
View raw schema 
{
  "description": "A reader's access grant, stored in the publication's business space. Authoritative: the processor's state only proposes changes to it. Grants the plan's spaces plus any listed here; at least one of plan or spaces should be set.",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "expiresAt": {
        "description": "When access ends. Paid entitlements set this to the end of the paid period plus a grace window and extend it on each payment. Omit for open-ended grants.",
        "format": "datetime",
        "type": "string"
      },
      "note": {
        "description": "Why a manual grant exists (e.g., 'Press pass', 'University site license').",
        "maxGraphemes": 1000,
        "maxLength": 10000,
        "type": "string"
      },
      "plan": {
        "description": "AT URI of the net.wireservice.plan this entitlement is for.",
        "format": "at-uri",
        "type": "string"
      },
      "reader": {
        "description": "URI of the net.wireservice.reader record.",
        "format": "uri",
        "type": "string"
      },
      "source": {
        "description": "Who manages this entitlement. Processor events never modify 'manual' entitlements.",
        "knownValues": [
          "stripe",
          "manual"
        ],
        "maxLength": 64,
        "type": "string"
      },
      "spaces": {
        "description": "Additional spaces granted, beyond the plan's.",
        "items": {
          "format": "space-ref",
          "type": "string"
        },
        "type": "array"
      },
      "stripeSubscriptionId": {
        "maxLength": 256,
        "type": "string"
      }
    },
    "required": [
      "reader",
      "source",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@