Roku · JSON Structure

Pay Web Services Refund Subscription Request Structure

RefundSubscriptionRequest schema from Roku Pay Web Services

Type: object Properties: 6 Required: 3
StreamingTelevisionMediaEntertainmentConnected TVConsumer Electronics

RefundSubscriptionRequest is a JSON Structure definition published by Roku, describing 6 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

partnerAPIKey rokuCustomerId transactionId refundAmount currency reason

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/roku/refs/heads/main/json-structure/pay-web-services-refund-subscription-request-structure.json",
  "name": "RefundSubscriptionRequest",
  "description": "RefundSubscriptionRequest schema from Roku Pay Web Services",
  "type": "object",
  "properties": {
    "partnerAPIKey": {
      "type": "string"
    },
    "rokuCustomerId": {
      "type": "string"
    },
    "transactionId": {
      "type": "string"
    },
    "refundAmount": {
      "type": "float",
      "description": "If omitted, a full refund is issued."
    },
    "currency": {
      "type": "string"
    },
    "reason": {
      "type": "string"
    }
  },
  "required": [
    "partnerAPIKey",
    "rokuCustomerId",
    "transactionId"
  ]
}