Payment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/prosperstack/main/json-schema/prosperstack-payment-schema.json",
  "title": "Payment",
  "x-generated": "2026-10-26",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/prosperstack-openapi.json#/components/schemas/Payment",
  "type": "object",
  "required": [
    "id",
    "type",
    "amount",
    "currency",
    "platform_invoice_id",
    "subscription",
    "subscriber",
    "paid_at"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "saved",
        "deflected"
      ]
    },
    "amount": {
      "type": "string"
    },
    "currency": {
      "type": "string"
    },
    "platform_invoice_id": {
      "type": "string"
    },
    "platform_invoice_number": {
      "type": "string"
    },
    "subscriber": {
      "$ref": "#/$defs/Subscriber"
    },
    "subscription": {
      "$ref": "#/$defs/Subscription"
    },
    "offer": {
      "oneOf": [
        {
          "$ref": "#/$defs/Offer"
        },
        {
          "type": "null"
        }
      ]
    },
    "paid_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "$defs": {
    "ChangeFrequencyOfferDetails": {
      "type": "object",
      "required": [
        "type",
        "interval",
        "interval_count",
        "metadata",
        "options"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "change_frequency"
          ]
        },
        "interval": {
          "type": "string",
          "enum": [
            "day",
            "week",
            "month",
            "year"
          ]
        },
        "interval_count": {
          "type": "number"
        },
        "metadata": {
          "type": "object"
        },
        "options": {
          "type": "array",
          "description": "All available change-frequency options for this offer",
          "items": {
            "type": "object",
            "required": [
              "interval",
              "interval_count",
              "metadata"
            ],
            "properties": {
              "interval": {
                "type": "string",
                "enum": [
                  "day",
                  "week",
                  "month",
                  "year"
                ]
              },
              "interval_count": {
                "type": "number"
              },
              "metadata": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "ChangePlanOfferDetails": {
      "type": "object",
      "required": [
        "type",
        "platform_plan_id",
        "prorate",
        "platform_coupon_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "change_plan"
          ]
        },
        "platform_plan_id": {
          "type": "string"
        },
        "prorate": {
          "type": "boolean"
        },
        "platform_coupon_id": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "CouponOfferDetails": {
      "type": "object",
      "required": [
        "type",
        "coupon_type",
        "amount_off",
        "duration",
        "months",
        "apply_to",
        "platform_coupon_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "coupon"
          ]
        },
        "coupon_type": {
          "type": "string",
          "enum": [
            "percentage",
            "fixed"
          ]
        },
        "amount_off": {
          "type": "string"
        },
        "duration": {
          "type": "string",
          "enum": [
            "once",
            "forever",
            "repeating"
          ]
        },
        "months": {
          "type": [
            "number",
            "null"
          ]
        },
        "apply_to": {
          "type": "string",
          "enum": [
            "subscription",
            "subscriber"
          ]
        },
        "platform_coupon_id": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "CustomOfferDetails": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "custom"
          ]
        }
      }
    },
    "DowngradeOfferDetails": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "downgrade"
          ]
        }
      }
    },
    "DunningOfferDetails": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "dunning"
          ]
        }
      }
    },
    "FreeGiftOfferDetails": {
      "type": "object",
      "required": [
        "type",
        "platform_variant_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "free_gift"
          ]
        },
        "platform_variant_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Platform-specific identifier of the product variant offered as the free gift"
        }
      }
    },
    "ModifySubscriptionOfferDetails": {
      "type": "object",
      "required": [
        "type",
        "modifications"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "modify_subscription"
          ]
        },
        "modifications": {
          "type": "array",
          "description": "Modifications applied to the subscription when the offer is accepted",
          "items": {
            "type": "object",
            "required": [
              "action",
              "platform_plan_id"
            ],
            "properties": {
              "action": {
                "type": "string",
                "enum": [
                  "add_plan",
                  "remove_plan",
                  "add_add_on",
                  "remove_add_on"
                ]
              },
              "platform_plan_id": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Platform-specific identifier of the plan or add-on affected by this modification"
              }
            }
          }
        }
      }
    },
    "Offer": {
      "type": "object",
      "required": [
        "id",
        "type",
        "goal",
        "context",
        "name",
        "details",
        "metadata",
        "created_at",
        "updated_at"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "change_frequency",
            "change_plan",
            "coupon",
            "custom",
            "downgrade",
            "dunning",
            "free_gift",
            "modify_subscription",
            "pause_subscription",
            "product_swap",
            "purchase",
            "reactivate",
            "reschedule_order",
            "trial_extension",
            "upgrade"
          ]
        },
        "goal": {
          "type": "string",
          "enum": [
            "retention",
            "conversion",
            "reactivation"
          ]
        },
        "context": {
          "type": "string",
          "enum": [
            "cancellation_flow",
            "conversion_campaign",
            "landing_page"
          ]
        },
        "name": {
          "type": "string"
        },
        "details": {
          "oneOf": [
            {
              "$ref": "#/$defs/ChangeFrequencyOfferDetails"
            },
            {
              "$ref": "#/$defs/ChangePlanOfferDetails"
            },
            {
              "$ref": "#/$defs/CouponOfferDetails"
            },
            {
              "$ref": "#/$defs/CustomOfferDetails"
            },
            {
              "$ref": "#/$defs/DowngradeOfferDetails"
            },
            {
              "$ref": "#/$defs/DunningOfferDetails"
            },
            {
              "$ref": "#/$defs/FreeGiftOfferDetails"
            },
            {
              "$ref": "#/$defs/ModifySubscriptionOfferDetails"
            },
            {
              "$ref": "#/$defs/PauseSubscriptionOfferDetails"
            },
            {
              "$ref": "#/$defs/ProductSwapOfferDetails"
            },
            {
              "$ref": "#/$defs/PurchaseOfferDetails"
            },
            {
              "$ref": "#/$defs/ReactivateOfferDetails"
            },
            {
              "$ref": "#/$defs/RescheduleOrderOfferDetails"
            },
            {
              "$ref": "#/$defs/TrialExtensionOfferDetails"
            },
            {
              "$ref": "#/$defs/UpgradeOfferDetails"
            }
          ]
        },
        "metadata": {
          "type": "object"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "PauseSubscriptionOfferDetails": {
      "type": "object",
      "required": [
        "type",
        "interval",
        "interval_count",
        "pause_at",
        "metadata",
        "options"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "pause_subscription"
          ]
        },
        "interval": {
          "type": "string",
          "enum": [
            "day",
            "week",
            "month",
            "indefinitely",
            "billing_cycle"
          ]
        },
        "interval_count": {
          "type": "number"
        },
        "pause_at": {
          "type": "string",
          "enum": [
            "immediately",
            "period_end"
          ]
        },
        "metadata": {
          "type": "object"
        },
        "options": {
          "type": "array",
          "description": "All available pause options for this offer",
          "items": {
            "type": "object",
            "required": [
              "interval",
              "interval_count",
              "metadata"
            ],
            "properties": {
              "interval": {
                "type": "string",
                "enum": [
                  "day",
                  "week",
                  "month",
                  "indefinitely",
                  "billing_cycle"
                ]
              },
              "interval_count": {
                "type": "number"
              },
              "metadata": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "ProductSwapOfferDetails": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "product_swap"
          ]
        }
      }
    },
    "PurchaseOfferDetails": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "purchase"
          ]
        }
      }
    },
    "ReactivateOfferDetails": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "reactivate"
          ]
        }
      }
    },
    "RescheduleOrderOfferDetails": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "reschedule_order"
          ]
        }
      }
    },
    "Subscriber": {
      "type": "object",
      "required": [
        "id",
        "platform_id",
        "name",
        "email",
        "status",
        "properties",
        "data",
        "created_at",
        "updated_at"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "platform_id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "canceled",
            "converted",
            "deflected",
            "inactive",
            "reactivated",
            "recovered",
            "saved"
          ]
        },
        "properties": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/SubscriberPropertyValue"
          }
        },
        "data": {
          "type": "object",
          "description": "Additional data about the subscriber from the connected subscription platform"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "SubscriberProperty": {
      "type": "object",
      "required": [
        "id",
        "key",
        "name",
        "entity",
        "type",
        "format"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "key": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "entity": {
          "type": "string",
          "enum": [
            "subscriber"
          ]
        },
        "type": {
          "type": "string",
          "enum": [
            "text",
            "number",
            "boolean",
            "date"
          ]
        },
        "format": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "number",
            "currency"
          ]
        }
      }
    },
    "SubscriberPropertyValue": {
      "type": "object",
      "required": [
        "property",
        "value",
        "formatted_value"
      ],
      "properties": {
        "property": {
          "$ref": "#/$defs/SubscriberProperty"
        },
        "value": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            }
          ]
        },
        "formatted_value": {
          "type": "string"
        }
      }
    },
    "Subscription": {
      "type": "object",
      "required": [
        "id",
        "platform_id",
        "subscriber_id",
        "mrr",
        "status",
        "properties",
        "data",
        "created_at",
        "updated_at"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "platform_id": {
          "type": "string"
        },
        "subscriber_id": {
          "type": "string"
        },
        "mrr": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "canceled",
            "future",
            "paused",
            "trialing"
          ]
        },
        "properties": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/SubscriptionPropertyValue"
          }
        },
        "data": {
          "type": "object",
          "description": "Additional data about the subscription from the connected subscription platform"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "SubscriptionProperty": {
      "type": "object",
      "required": [
        "id",
        "key",
        "name",
        "entity",
        "type",
        "format"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "key": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "entity": {
          "type": "string",
          "enum": [
            "subscription"
          ]
        },
        "type": {
          "type": "string",
          "enum": [
            "text",
            "number",
            "boolean",
            "date"
          ]
        },
        "format": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "number",
            "currency"
          ]
        }
      }
    },
    "SubscriptionPropertyValue": {
      "type": "object",
      "required": [
        "property",
        "value",
        "formatted_value"
      ],
      "properties": {
        "property": {
          "$ref": "#/$defs/SubscriptionProperty"
        },
        "value": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            }
          ]
        },
        "formatted_value": {
          "type": "string"
        }
      }
    },
    "TrialExtensionOfferDetails": {
      "type": "object",
      "required": [
        "type",
        "days"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "trial_extension"
          ]
        },
        "days": {
          "type": "number"
        }
      }
    },
    "UpgradeOfferDetails": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "upgrade"
          ]
        }
      }
    }
  }
}