fund.at.funding.plan

at.fund

Documentation

A funding plan — a named tier or suggested contribution level. References payment channels by AT URI, which may be in this account or any other account's fund.at.funding.channel records.

main record

A funding plan — a named tier or suggested contribution level. References payment channels by AT URI, which may be in this account or any other account's fund.at.funding.channel records.

Record Key any Any valid record key

Properties

amount integer Optional

Suggested amount in the smallest currency unit (e.g. cents for USD). Use 0 for 'any amount'. Maps to funding.json plan.amount (converted from whole units).

channels array of string at-uri Optional

AT URIs of fund.at.funding.channel records where this plan can be fulfilled. May reference channels in any account. If omitted, all of this account's channels apply.

maxLength: 10 items
createdAt string datetime Optional

When this record was created or last updated.

currency string Optional

ISO 4217 currency code (e.g. 'USD', 'EUR').

maxLength: 3 bytes
description string Optional

What this plan covers or how the funds are used.

maxLength: 500 bytes
frequency string Optional

How often the plan is billed. Maps to funding.json plan.frequency.

maxLength: 16 bytes
Known values: one-time, weekly, fortnightly, monthly, yearly, other
name string Required

Human-readable plan name (e.g. 'Supporter', 'Sustainer').

maxLength: 128 bytes
status string Optional

Whether this plan is currently accepting contributions. Maps to funding.json plan.status.

maxLength: 16 bytes
Known values: active, inactive
View raw schema 
{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 128,
        "description": "Human-readable plan name (e.g. 'Supporter', 'Sustainer')."
      },
      "amount": {
        "type": "integer",
        "description": "Suggested amount in the smallest currency unit (e.g. cents for USD). Use 0 for 'any amount'. Maps to funding.json plan.amount (converted from whole units)."
      },
      "status": {
        "type": "string",
        "maxLength": 16,
        "description": "Whether this plan is currently accepting contributions. Maps to funding.json plan.status.",
        "knownValues": [
          "active",
          "inactive"
        ]
      },
      "channels": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "maxLength": 10,
        "description": "AT URIs of fund.at.funding.channel records where this plan can be fulfilled. May reference channels in any account. If omitted, all of this account's channels apply."
      },
      "currency": {
        "type": "string",
        "maxLength": 3,
        "description": "ISO 4217 currency code (e.g. 'USD', 'EUR')."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "When this record was created or last updated."
      },
      "frequency": {
        "type": "string",
        "maxLength": 16,
        "description": "How often the plan is billed. Maps to funding.json plan.frequency.",
        "knownValues": [
          "one-time",
          "weekly",
          "fortnightly",
          "monthly",
          "yearly",
          "other"
        ]
      },
      "description": {
        "type": "string",
        "maxLength": 500,
        "description": "What this plan covers or how the funds are used."
      }
    }
  },
  "description": "A funding plan — a named tier or suggested contribution level. References payment channels by AT URI, which may be in this account or any other account's fund.at.funding.channel records."
}

Lexicon Garden

@